Technical Documentation

1. Scope of Development

• Need for it
• Use Cases

2. Building Blocks

• Integration between them
• External implementation that should be part of it
• Integration with the ecosystem
  • NAD, ABC
• Ecosystem
  • Private Schools

3. API Docs

• Core APIs
• Utility APIs (including BFF)
  • QR Code
  • Rendering of Credentials/Presentation
  • Sharing of Credentials

4. LLDs

• DB Stucture
• Caching Mechanisms
• Authentication
• Authorization

5. Tech Stack

• Backend
  • Service A
  • Service B...
• Frontend
  • Client A
  • Client B...

6. Deployment (CI/CD)

7. SDKs and Libraries

• Types (Typescript for Frontend and Backend Dev)
• Verification Libraries
• Wallet Integration SDKs

8. Reference Implementation

• Scope
• Deployment
• Delta from the full scale solution
• Mocks for all APIs

9. Scalability

• Required Scale
• Benchmarking
  • Scripts
• Expectation

10. Structuring GitHub

• Repository Nomenclature
• Versioning of Releases (Sementic)
• Readme formatting
• Issue Management
  • Formatting per repo
  • Tags
• Discussion Forums

11. Developer Workflow

12. JIRA

13. Ownership and Contributors

14. Testing

15. Versioning and Milestoning

16. Log Management

External Review

1. Design Council

2. Security Audit (of Design Doc)

Supporting Docs

1. Workflows
2. Interaction Design
3. Visual Design