Documentation Guide

Table of contents

1. Setting up and maintaining the project website
2. Style guidance
3. Diagrams
4. Converting a document to the PDF format

1. Setting up and maintaining the project website

• We use Intellij's inbuilt markdown editor to maintain our documentations of this project
• The docs/ folder is used for documentation.

2. Style guidance

• We follow the Google developer documentation style guide.

• We also refer to [se-edu/guides] Markdown coding standard

3. Diagrams

• We use PlantUML diagrams[se-edu/guides] Using PlantUML

• We also use Draw.io for our diagrams Using Draw.io

• We also use .pptx for our diagrams. The .pptx files can be found in the images folder. To update a diagram, the diagrams in the .pptx files can be modified.

4. Converting a document to the PDF format

• We follow this guide to convert our documents to PDF[se-edu/guides] Saving web documents as PDF files

Home Page