HireMe
Home
User Guide
Developer Guide
About Us
Search
Home
User Guide
Overview of User Guide
How to use our User Guide
Quick start
Features
FAQ
Troubleshooting
Known Issues
Command summary
Glossary
Acknowledgements
Developer Guide
Acknowledgements
Setting Up
Design
Implementation
Documentation, logging, testing, configuration, dev-ops
Appendix: Requirements
Appendix: Instructions for manual testing
Appendix: Planned Enhancements
About Us
Documentation Guide
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.
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ā