+ 2

how to write documentation?

how to write documentation? when i see docs folder in some open source projects it looks more like pseudocodes(because it is similary structured like code). how do you write and read documentation?

26th Apr 2018, 3:03 PM
shobhit
shobhit - avatar
3 Respostas
+ 2
i m basically writing a new software how should i document the code and how that software works.
26th Apr 2018, 6:04 PM
shobhit
shobhit - avatar
0
What kind of documents do you want to describe? Architecture of the system? Requirements? Other things?
26th Apr 2018, 5:42 PM
***
*** - avatar
0
Are you writing it for a customer or not? If yes, try to describe the functional (use case descriptions + use case diagram) and non-functional (ISO 25010) requirements + project scope/goal/context. And besides that: try to describe your architecture. Think about writing clean code. Layer/componentmodel, deploymentmodel, development resources, classdiagram, tiermodel and any other diagram that brings clarity about your application. Main purpose: when you stop writing the code and leave it for other developers, they can read some documentation about the goal/setup from the application. Does that fit your needs?
26th Apr 2018, 7:00 PM
***
*** - avatar