This repository contains standardized templates for software engineering documentation, focusing on .NET/C# development with Clean Architecture and Domain-Driven Design principles.
These templates establish a consistent approach to documenting software projects, enabling:
- Improved onboarding for new team members
- Better knowledge sharing and preservation
- Enhanced collaboration across teams
- More maintainable software through clear architectural documentation
- Consistent design decisions through structured ADRs
- Project README: Basic project information and overview
- Architecture Documentation: System architecture, components, and patterns
- Development Guidelines: Project-specific development standards
- API Documentation: API specifications and examples
- Testing Strategy: Testing approach and methods
- Deployment Process: Deployment procedures and environments
- Domain Concept: Domain model documentation
- ADR Template: Architectural decision records
- Glossary: Terminology definitions
- Usage Guide: Instructions for using these templates
- Folder Structure: Recommended organization for project documentation
- Examples: Sample documentation for reference
See the Usage Guide for instructions on how to use these templates in your projects.
Contributions to improve these templates are welcome! Please feel free to submit pull requests or open issues with suggestions.
These templates are available under the MIT License.