TrackIt@NUS Documentation

Introduction

We use Markdown for documentation purposes because it provides ease of writing and formatting.

Setup and Maintenance

• We use Jekyll to manage documentation.
• The docs/ folder is used for documentation.
• To learn how set it up and maintain the project website, follow the guide [se-edu/guides] Using Jekyll for project documentation.

Markdown Guidance

• Follow the Google developer documentation style guide.

• Also relevant is the [se-edu/guides] Markdown coding standard

Editing Diagrams

• See the [se-edu/guides] Using PlantUML

Converting Documentation to PDF format

• See the guide [se-edu/guides] Saving web documents as PDF files