Design document templates for the service — a social media platform (Viejo App) for reconnecting with old friends and close-knit groups.
.
├── README.md # This file
├── Templates.md # Template index & usage guide
├── Sample.md # Sample index & overview
├── templates/
│ ├── en/ # English templates
│ │ ├── microservice-design.md
│ │ └── clean-architecture-design.md
│ └── ja/ # Japanese templates (日本語テンプレート)
│ ├── microservice-design.md
│ └── clean-architecture-design.md
├── samples/
│ ├── en/ # English filled examples
│ │ ├── microservice-design-sample.md
│ │ └── clean-architecture-design-sample.md
│ └── ja/ # Japanese filled examples (日本語サンプル)
│ ├── microservice-design-sample.md
│ └── clean-architecture-design-sample.md
└── docx/
├── en/ # English Word documents
│ ├── microservice-design-template.docx
│ ├── clean-architecture-design-template.docx
│ ├── microservice-design-sample.docx
│ └── clean-architecture-design-sample.docx
└── ja/ # Japanese Word documents (日本語Word文書)
├── microservice-design-template.docx
├── clean-architecture-design-template.docx
├── microservice-design-sample.docx
└── clean-architecture-design-sample.docx
- Choose a template from
templates/en/ortemplates/ja/ - Copy the template into your project documentation folder
- Fill in each section following the guidance in brackets
[...] - Refer to samples in
samples/for concrete examples based on the the service - Word versions are available in
docx/for offline editing and formal review
| Template | Description |
|---|---|
| Microservice Design Doc | For designing individual microservices: API contracts, data models, deployment, and inter-service communication |
| Clean Architecture Design Doc | For defining layered architecture: entities, use cases, interface adapters, and dependency rules |
This project is licensed under the MIT License — see the LICENSE file for details.
This site is hosted and deployed by Netlify.