Documentation – Structure

Hello Dears,

Here are some guide points to write our documentation ..

• Introduction (usually discusses why you picked the project, problem definition, how it solves it, the need + how u planned the work + how the documentation is gonna go on)
• Design (you define the design and architecture of the project, include any design documents/diagrams you can come up with)
• Implementation (most probably that’s a few chapters, we wrote every module as a separate chapter since the overall was defined at the beginning)
• Results (what did you achieve, challenges and problems faced, results, graphs, demos, snapshots, etc)
• Related Work (with comparison), Future Work, Appendices (if u need any – extra explanation, important code references, scientific explanation, etc) and References