Vous ne pouvez pas sélectionner plus de 25 sujets Les noms de sujets doivent commencer par une lettre ou un nombre, peuvent contenir des tirets ('-') et peuvent comporter jusqu'à 35 caractères.

project-overview-template.md 1.9KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103
  1. # {{project_name}} - Project Overview
  2. **Date:** {{date}}
  3. **Type:** {{project_type}}
  4. **Architecture:** {{architecture_type}}
  5. ## Executive Summary
  6. {{executive_summary}}
  7. ## Project Classification
  8. - **Repository Type:** {{repository_type}}
  9. - **Project Type(s):** {{project_types_list}}
  10. - **Primary Language(s):** {{primary_languages}}
  11. - **Architecture Pattern:** {{architecture_pattern}}
  12. {{#if is_multi_part}}
  13. ## Multi-Part Structure
  14. This project consists of {{parts_count}} distinct parts:
  15. {{#each project_parts}}
  16. ### {{part_name}}
  17. - **Type:** {{project_type}}
  18. - **Location:** `{{root_path}}`
  19. - **Purpose:** {{purpose}}
  20. - **Tech Stack:** {{tech_stack}}
  21. {{/each}}
  22. ### How Parts Integrate
  23. {{integration_description}}
  24. {{/if}}
  25. ## Technology Stack Summary
  26. {{#if is_single_part}}
  27. {{technology_table}}
  28. {{else}}
  29. {{#each project_parts}}
  30. ### {{part_name}} Stack
  31. {{technology_table}}
  32. {{/each}}
  33. {{/if}}
  34. ## Key Features
  35. {{key_features}}
  36. ## Architecture Highlights
  37. {{architecture_highlights}}
  38. ## Development Overview
  39. ### Prerequisites
  40. {{prerequisites}}
  41. ### Getting Started
  42. {{getting_started_summary}}
  43. ### Key Commands
  44. {{#if is_single_part}}
  45. - **Install:** `{{install_command}}`
  46. - **Dev:** `{{dev_command}}`
  47. - **Build:** `{{build_command}}`
  48. - **Test:** `{{test_command}}`
  49. {{else}}
  50. {{#each project_parts}}
  51. #### {{part_name}}
  52. - **Install:** `{{install_command}}`
  53. - **Dev:** `{{dev_command}}`
  54. {{/each}}
  55. {{/if}}
  56. ## Repository Structure
  57. {{repository_structure_summary}}
  58. ## Documentation Map
  59. For detailed information, see:
  60. - [index.md](./index.md) - Master documentation index
  61. - [architecture.md](./architecture{{#if is_multi_part}}-{part_id}{{/if}}.md) - Detailed architecture
  62. - [source-tree-analysis.md](./source-tree-analysis.md) - Directory structure
  63. - [development-guide.md](./development-guide{{#if is_multi_part}}-{part_id}{{/if}}.md) - Development workflow
  64. ---
  65. _Generated using BMAD Method `document-project` workflow_