ProjectEx
User Guide
Developer Guide
About Us
Search
Home
User Guide
Quick Start
Features
FAQ
Developer Guide
Setting Up
Tutorial: Tracing code
Design
Implementation
Project Guides
Documentation
Testing
Configuration
DevOps
Appendix
Requirements
About Us
Contributor Portfolio Template
Documentation Guide
This page can be used to understand the documentation practices and link to relevant sources to help developers contribute to documentation.
We use
MarkBind
to manage documentation.
The
docs/
folder contains the source files for the documentation website.
To learn how set it up and maintain the project website, follow the guide
[se-edu/guides] Working with Forked MarkBind sites
for project documentation.
Updating documentation as changes are made to the project is ideal for any project.
Style guidance:
Follow the
Google developer documentation style guide
.
Also relevant is the
se-edu/guides
Markdown coding standard
.
Converting to PDF
See the guide
se-edu/guides
Saving web documents as PDF files
.
Documentation Guide