What sort of technical documentation should be there while planing a large level web application? Like if need to develop a web application using the microservices architecture then we can think about the following documents in planing: 1. Flow charts 2. DFD & 3. Microservices Structure But, when we think about the complete technical management of a product then we also need to think about these things: 1. Change management 2. Technology selection 3. Server infrastructure 4. POC of different stack and approach So, the only Flow Charts & DFD are not sufficient I think. Anyone here can help to think this on a broad level like how to plan for the next 5-10 years today.

ArchitectureStrategy
2.8k viewscircle icon3 Upvotescircle icon4 Comments
Sort by:
CTO in Software5 years ago

Start with a high level design document that outlines both the *how* and *why* of the application. From that create Milestones, Epics, and Stories that give Developers clear deliverables. For microservices architectures, or any that involve API endpoints, use a tool such as Swagger to keep APIs well documented and understandable by all.

Lightbulb on1
Director Certifications in Education5 years ago

Security requirements throughout the SDLC process (planning to implementation/maintenance).

Lightbulb on1
Group Chief Information Officer in Construction5 years ago

There are no particular standard for documentation sets
What is more important is to follow best practices in development with proper comments and well organised code structure

1 Reply
no title5 years ago

Yes, to an extent you are right that we can not just write down a simple process of documentation for all kind of software and application as it depends on the complexity and category of software.<br><br>But, I am just looking for an idea about planning a big web application. Like what sort of things can be there to think or draw before initiating the development, so that we can ensure the stability of product for next 4-5 years in terms for technology, feasibility, expand or scale the structure etc.

Content you might like

How do you think AI will disrupt business across industries? Add to my list: 1. Content creation 2. Photos and video production 3. Basic coding and debugging 4. Strategic analysis to be highly complimented 

Read More Comments

How would you describe your organization’s current stage in adopting SAP Joule?

Exploring – We are aware of SAP Joule but have not yet started any formal evaluation or planning.19%

Evaluating – We are actively assessing SAP Joule’s capabilities and fit for our business needs.52%

Piloting – We have initiated a limited rollout or proof of concept in selected areas.9%

Scaling – We are expanding SAP Joule adoption across multiple business units, processes or systems.15%

Operationalized – SAP Joule is fully integrated into our operations and delivering measurable value.6%

View Results

In five years, who do you expect your company's main competitor to be?

An emerging startup or existing digital native company27%

An existing nondigital company49%

A current competitor22%

Other (comment below)

View Results

How do you manage your enterprise content efficiently, and how is your organization (specific to content)?

Has anyone in the community seen credible signals or speculation about Broadcom's next acquisition targets? We're particularly interested in whether companies like ServiceNow or Dynatrace might be on their radar, and how others are preparing for such scenarios.