-
Notifications
You must be signed in to change notification settings - Fork 0
Open
Labels
documentationImprovements or additions to documentationImprovements or additions to documentationgood first issueGood for newcomersGood for newcomers
Description
Description
Create comprehensive documentation including a README, tutorials, schema reference, and contributing guide. Documentation should make the tool accessible to both security professionals new to quantum threats and experienced cryptographers.
Tasks
- README:
- Feature overview and project motivation
- Quick start guide (install, first assessment in 5 minutes)
- Example output screenshots/snippets
- Badge integration (CI status, version, license)
- Tutorial: Threat modeling a simple web application:
- Step-by-step walkthrough from architecture definition to report
- Explain each field in the schema with context
- Interpret assessment results and risk scores
- Apply recommended mitigations
- Tutorial: Assessing a microservices architecture:
- Complex architecture with multiple crypto boundaries
- Supply chain considerations
- Prioritizing migration across many services
- Schema reference documentation:
- Complete field-by-field reference for architecture schema
- Valid values and constraints for each field
- Examples for each component type
- Knowledge base reference:
- All tracked algorithms and their quantum status
- Quantum attack complexity for each algorithm
- Recommended replacements
- Contributing guide:
- Development setup instructions
- Code style and testing requirements
- How to add new algorithms to the knowledge base
- How to add new compliance standards
References
- Depends on: all other modules for accurate documentation
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
documentationImprovements or additions to documentationImprovements or additions to documentationgood first issueGood for newcomersGood for newcomers