문서화 템플릿
원문: documentation-templates
Documentation templates and structure guidelines. README, API docs, code comments, and AI-friendly documentation.
무엇을 하나요
Documentation Templates Templates and structure guidelines for common documentation types. 1. README Structure Essential Sections (Priority Order) | Section | Purpose | | | | | Title + One liner | What is this? | | Quick Start | Running in <5 min | | Features | What can I do? | | Configuration | How to customize | | API Reference | Link to detailed docs | | Contributing | How to help | | License | Legal | README Template 2. API Documentation Structure Per Endpoint Template 3. Code Comment Guidelines JSDoc/TSDoc Template When to Comment | ✅ Comment | ❌ Don't Comment | | | | | Why (business logic) | What (obvious) | | Complex algorithms | Every line | | Non obvious behavior | Self explanatory …
실행 시 본인 API 키(BYOK)로 동작하며, 모델 비용은 사용자 계정에서 직접 결제됩니다.