BandBook
Home
User Guide
Developer Guide
About Us
Search
Site Map
Home
User Guide
Introduction & Product Information
Purpose of User Guide
Target User
Quick Start
Features
FAQ
Known Issues
Command Summary
Glossary
Acknowledgements
Developer Guide
Acknowledgements
Setting Up
Design
Implementation
Documentation, logging, testing, configuration, dev-ops
Appendix A: Requirements
Appendix B: Instructions for Manual Testing
Appendix C: Effort
Appendix D: Possible Future Enhancements
Tutorials
Tracing code
Adding a command
Removing Fields
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ā