👩🏻💻Describe what your program does from start to finish. It needs to be so detailed that you could implement it based on the description.
📊Include architectural diagrams to enhance the understanding
📝Write down the steps of how to install, update and run the software
🖼Add screenshots
🖥Add infos about the servers used for development, testing and production
What would you like to add?
Top comments (4)
I like to start with a overview of the business side "why does this app exists?" I think it's a lot easier to understand how the app works if you understand why it was created
Hi Marcell, that's a great idea, thanks for sharing! 😊
👍 Your list sometimes is also referred as - requirements, design (high level and low level), user guide and developer's manual.
Hi Prasad, yes thank you for the addition! 😊 👍