Initial commit

skills/documentation-architecture/templates/INDEX.md

@@ -0,0 +1,59 @@
+# Documentation Templates
+
+Copy-paste ready templates for API documentation, architecture docs, and OpenAPI specifications.
+
+## Available Templates
+
+### [API Endpoint Documentation](api-endpoint.md)
+
+Complete template for documenting a single API endpoint with all required sections.
+
+**Includes**: Method/path, description, authentication, request/response formats, error codes, rate limits, code examples
+
+**Use when**: Documenting REST API endpoints, creating API reference pages
+
+---
+
+### [Architecture Document](architecture-doc.md)
+
+Comprehensive template for system architecture documentation with Mermaid diagrams.
+
+**Includes**: Executive summary, system overview, component descriptions, data flow, ADRs, security model
+
+**Use when**: Documenting new systems, onboarding materials, architecture reviews
+
+---
+
+### [OpenAPI Specification](openapi-spec.yaml)
+
+Starter OpenAPI 3.1 specification with common patterns and best practices.
+
+**Includes**: Info object, servers, authentication, common schemas (errors, pagination), example endpoint
+
+**Use when**: Starting new API documentation, generating from scratch
+
+---
+
+## Quick Start
+
+1. Copy template file to your documentation directory
+2. Replace all `[FILL IN]` placeholders
+3. Remove optional sections if not needed
+4. Validate and test
+
+## Template Customization
+
+**For your project**:
+- Update company/project names
+- Adjust authentication schemes
+- Add project-specific error codes
+- Include relevant examples
+
+**For your team**:
+- Add team-specific sections
+- Include internal links
+- Reference team tools/dashboards
+
+---
+
+Related: [Examples](../examples/INDEX.md) | [Reference](../reference/INDEX.md) | [Return to Agent](../docs-architect.md)