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.
Sort by:
Security requirements throughout the SDLC process (planning to implementation/maintenance).
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
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.
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.