Avengers Assemble
Home
User Guide
Developer Guide
About Us
Search
Site Map
Home
User Guide
Table of Contents
Quick Start
Contact Management Features
Exam Management Features
Additional Information
FAQ
Known Issues
Command Summary
Command Parameter Summary
Developer Guide
Acknowledgements
Setting Up
Design
Implementation
Documentation, logging, testing, configuration, dev-ops
Appendix A: Product Scope
Appendix B: User Stories
Appendix C: Use Cases
Appendix D: Non-Functional Requirements
Appendix E: Glossary
Appendix F: Instructions for manual testing
Appendix G: Effort
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ā