How do you write a documentation for a new project? | Sololearn: Learn to code for FREE!
New course! Every coder should learn Generative AI!
Try a free lesson
+ 2

How do you write a documentation for a new project?

I have this idea to create a learning webapp for high schoolers. Something like solo learn as an idea but far away from it's function. I want mine to be more like moodle yet very simple to use. Hence a virtual classroom. Is it possible to have this documented before starting the project or after the project is completed. Thanks.

27th Dec 2019, 9:50 AM
JoeOkat
JoeOkat - avatar
4 Answers
+ 1
Documentation usually comes after the project is complete. If you want for something to show how this web app will function and it's components/dependencies, you could make UML diagrams (Deployment, Activity etc.).
27th Dec 2019, 3:42 PM
Veliside
Veliside - avatar
+ 1
Oh you want it for the users, well yeah, no problem to write something like a presentation of what this app will do. When I read documentation, I thought of a user manual.
29th Dec 2019, 7:59 AM
Veliside
Veliside - avatar
0
Ohkay, but will users understand this UML diagram the way you and I do? I mean wouldn't it be easy to just write something in text to explain how the software or project in question works?
29th Dec 2019, 5:50 AM
JoeOkat
JoeOkat - avatar
0
Ohkay
30th Dec 2019, 4:39 PM
JoeOkat
JoeOkat - avatar