mirror of
https://github.com/catlog22/Claude-Code-Workflow.git
synced 2026-02-05 01:50:27 +08:00
3ec5de821d
- Introduced a unified API documentation template covering both Code API and HTTP API sections. - Created a folder navigation documentation template for directories containing subdirectories. - Developed a module README documentation template focusing on module purpose, usage, and dependencies. - Added a project architecture documentation template synthesizing module information and system design. - Implemented a project examples documentation template showcasing practical usage scenarios. - Established a project-level documentation template outlining project overview, architecture, and navigation.
59 lines
1.7 KiB
Plaintext
59 lines
1.7 KiB
Plaintext
# Project-Level Documentation Template
|
|
|
|
Generate comprehensive project documentation following this structure:
|
|
|
|
## 1. Overview
|
|
- **Purpose**: [High-level mission and goals of the project]
|
|
- **Target Audience**: [Primary users, developers, stakeholders]
|
|
- **Key Features**: [List of major functionalities and capabilities]
|
|
|
|
## 2. System Architecture
|
|
- **Architectural Style**: [e.g., Monolith, Microservices, Layered, Event-Driven]
|
|
- **Core Components**: [Diagram or list of major system parts and their interactions]
|
|
- **Technology Stack**:
|
|
- Languages: [Programming languages used]
|
|
- Frameworks: [Key frameworks and libraries]
|
|
- Databases: [Data storage solutions]
|
|
- Infrastructure: [Deployment and hosting]
|
|
- **Design Principles**: [Guiding principles like SOLID, DRY, separation of concerns]
|
|
|
|
## 3. Getting Started
|
|
- **Prerequisites**: [Required software, tools, versions]
|
|
- **Installation**:
|
|
```bash
|
|
# Installation commands
|
|
```
|
|
- **Configuration**: [Environment setup, config files]
|
|
- **Running the Project**:
|
|
```bash
|
|
# Startup commands
|
|
```
|
|
|
|
## 4. Development Workflow
|
|
- **Branching Strategy**: [e.g., GitFlow, trunk-based]
|
|
- **Coding Standards**: [Style guide, linting rules]
|
|
- **Testing**:
|
|
```bash
|
|
# Test commands
|
|
```
|
|
- **Build & Deployment**: [CI/CD pipeline overview]
|
|
|
|
## 5. Project Structure
|
|
```
|
|
project-root/
|
|
├── src/ # [Description]
|
|
├── tests/ # [Description]
|
|
├── docs/ # [Description]
|
|
└── config/ # [Description]
|
|
```
|
|
|
|
## 6. Navigation
|
|
- [Module Documentation](./modules/)
|
|
- [API Reference](./api/)
|
|
- [Architecture Details](./architecture/)
|
|
- [Contributing Guidelines](./CONTRIBUTING.md)
|
|
|
|
---
|
|
**Last Updated**: [Auto-generated timestamp]
|
|
**Documentation Version**: [Project version]
|