Developer
22 lines
1.0 KiB
Markdown
22 lines
1.0 KiB
Markdown
# docs/templates
|
|
dir: docs/templates
|
|
|
|
index: docs/templates/.pi-map.index.md
|
|
|
|
## role
|
|
Provides standardized markdown templates for consistent documentation of API endpoints, system architecture, and product features across the project.
|
|
## files
|
|
- api-endpoint.md | Provides a standardized markdown template for documenting REST API endpoints with request/response specifications and examples.
|
|
- architecture.md | Provides a markdown template for documenting system architecture with standardized sections for components, data flow, technology stack, and operational considerations.
|
|
- feature-doc.md | Provides a markdown template for documenting new product features with standardized sections covering overview, usage, API reference, configuration, and troubleshooting.
|
|
## arch
|
|
Template-based documentation pattern using structured, fill-in-the-section markdown files to enforce uniform documentation standards and reduce authoring overhead.
|
|
## tags
|
|
api, provides, standardized, markdown, template, documenting, architecture, endpoint
|
|
## symbols
|
|
-
|
|
## workflows
|
|
-
|
|
## dirty
|
|
-
|