{"id":"316917be-797f-4a4e-8f23-2468bb1db38b","shortId":"BfxuVv","kind":"skill","title":"documentation-templates","tagline":"Documentation templates and structure guidelines. README, API docs, code comments, and AI-friendly documentation.","description":"# Documentation Templates\n\n> Templates and structure guidelines for common documentation types.\n\n---\n\n## 1. README Structure\n\n### Essential Sections (Priority Order)\n\n| Section | Purpose |\n|---------|---------|\n| **Title + One-liner** | What is this? |\n| **Quick Start** | Running in <5 min |\n| **Features** | What can I do? |\n| **Configuration** | How to customize |\n| **API Reference** | Link to detailed docs |\n| **Contributing** | How to help |\n| **License** | Legal |\n\n### README Template\n\n```markdown\n# Project Name\n\nBrief one-line description.\n\n## Quick Start\n\n[Minimum steps to run]\n\n## Features\n\n- Feature 1\n- Feature 2\n\n## Configuration\n\n| Variable | Description | Default |\n|----------|-------------|---------|\n| PORT | Server port | 3000 |\n\n## Documentation\n\n- API Reference\n- Architecture\n\n## License\n\nMIT\n```\n\n---\n\n## 2. API Documentation Structure\n\n### Per-Endpoint Template\n\n```markdown\n## GET /users/:id\n\nGet a user by ID.\n\n**Parameters:**\n| Name | Type | Required | Description |\n|------|------|----------|-------------|\n| id | string | Yes | User ID |\n\n**Response:**\n- 200: User object\n- 404: User not found\n\n**Example:**\n[Request and response example]\n```\n\n---\n\n## 3. Code Comment Guidelines\n\n### JSDoc/TSDoc Template\n\n```typescript\n/**\n * Brief description of what the function does.\n * \n * @param paramName - Description of parameter\n * @returns Description of return value\n * @throws ErrorType - When this error occurs\n * \n * @example\n * const result = functionName(input);\n */\n```\n\n### When to Comment\n\n| ✅ Comment | ❌ Don't Comment |\n|-----------|-----------------|\n| Why (business logic) | What (obvious) |\n| Complex algorithms | Every line |\n| Non-obvious behavior | Self-explanatory code |\n| API contracts | Implementation details |\n\n---\n\n## 4. Changelog Template (Keep a Changelog)\n\n```markdown\n# Changelog\n\n## [Unreleased]\n### Added\n- New feature\n\n## [1.0.0] - 2025-01-01\n### Added\n- Initial release\n### Changed\n- Updated dependency\n### Fixed\n- Bug fix\n```\n\n---\n\n## 5. Architecture Decision Record (ADR)\n\n```markdown\n# ADR-001: [Title]\n\n## Status\nAccepted / Deprecated / Superseded\n\n## Context\nWhy are we making this decision?\n\n## Decision\nWhat did we decide?\n\n## Consequences\nWhat are the trade-offs?\n```\n\n---\n\n## 6. AI-Friendly Documentation (2025)\n\n### llms.txt Template\n\nFor AI crawlers and agents:\n\n```markdown\n# Project Name\n> One-line objective.\n\n## Core Files\n- [src/index.ts]: Main entry\n- [src/api/]: API routes\n- [docs/]: Documentation\n\n## Key Concepts\n- Concept 1: Brief explanation\n- Concept 2: Brief explanation\n```\n\n### MCP-Ready Documentation\n\nFor RAG indexing:\n- Clear H1-H3 hierarchy\n- JSON/YAML examples for data structures\n- Mermaid diagrams for flows\n- Self-contained sections\n\n---\n\n## 7. Structure Principles\n\n| Principle | Why |\n|-----------|-----|\n| **Scannable** | Headers, lists, tables |\n| **Examples first** | Show, don't just tell |\n| **Progressive detail** | Simple → Complex |\n| **Up to date** | Outdated = misleading |\n\n---\n\n> **Remember:** Templates are starting points. Adapt to your project's needs.\n\n## When to Use\nThis skill is applicable to execute the workflow or actions described in the overview.\n\n## Limitations\n- Use this skill only when the task clearly matches the scope described above.\n- Do not treat the output as a substitute for environment-specific validation, testing, or expert review.\n- Stop and ask for clarification if required inputs, permissions, safety boundaries, or success criteria are missing.","tags":["documentation","templates","antigravity","awesome","skills","sickn33","agent-skills","agentic-skills","ai-agent-skills","ai-agents","ai-coding","ai-workflows"],"capabilities":["skill","source-sickn33","skill-documentation-templates","topic-agent-skills","topic-agentic-skills","topic-ai-agent-skills","topic-ai-agents","topic-ai-coding","topic-ai-workflows","topic-antigravity","topic-antigravity-skills","topic-claude-code","topic-claude-code-skills","topic-codex-cli","topic-codex-skills"],"categories":["antigravity-awesome-skills"],"synonyms":[],"warnings":[],"endpointUrl":"https://skills.sh/sickn33/antigravity-awesome-skills/documentation-templates","protocol":"skill","transport":"skills-sh","auth":{"type":"none","details":{"cli":"npx skills add sickn33/antigravity-awesome-skills","source_repo":"https://github.com/sickn33/antigravity-awesome-skills","install_from":"skills.sh"}},"qualityScore":"0.700","qualityRationale":"deterministic score 0.70 from registry signals: · indexed on github topic:agent-skills · 37911 github stars · SKILL.md body (3,486 chars)","verified":false,"liveness":"unknown","lastLivenessCheck":null,"agentReviews":{"count":0,"score_avg":null,"cost_usd_avg":null,"success_rate":null,"latency_p50_ms":null,"narrative_summary":null,"summary_updated_at":null},"enrichmentModel":"deterministic:skill-github:v1","enrichmentVersion":1,"enrichedAt":"2026-05-18T18:50:57.542Z","embedding":null,"createdAt":"2026-04-18T20:33:31.048Z","updatedAt":"2026-05-18T18:50:57.542Z","lastSeenAt":"2026-05-18T18:50:57.542Z","tsv":"'-001':242 '-01':224,225 '/users':117 '1':29,90,300 '1.0.0':222 '2':92,107,304 '200':135 '2025':223,272 '3':147 '3000':100 '4':210 '404':138 '5':49,235 '6':267 '7':332 'accept':245 'action':380 'ad':219,226 'adapt':362 'adr':239,241 'agent':279 'ai':16,269,276 'ai-friend':15,268 'algorithm':195 'api':10,60,102,108,206,293 'applic':374 'architectur':104,236 'ask':418 'behavior':201 'boundari':426 'brief':77,154,301,305 'bug':233 'busi':190 'chang':229 'changelog':211,215,217 'clarif':420 'clear':314,393 'code':12,148,205 'comment':13,149,184,185,188 'common':26 'complex':194,351 'concept':298,299,303 'configur':56,93 'consequ':260 'const':178 'contain':330 'context':248 'contract':207 'contribut':66 'core':287 'crawler':277 'criteria':429 'custom':59 'data':322 'date':354 'decid':259 'decis':237,254,255 'default':96 'depend':231 'deprec':246 'describ':381,397 'descript':81,95,128,155,163,167 'detail':64,209,349 'diagram':325 'doc':11,65,295 'document':2,4,18,19,27,101,109,271,296,310 'documentation-templ':1 'endpoint':113 'entri':291 'environ':409 'environment-specif':408 'error':175 'errortyp':172 'essenti':32 'everi':196 'exampl':142,146,177,320,341 'execut':376 'expert':414 'explan':302,306 'explanatori':204 'featur':51,88,89,91,221 'file':288 'first':342 'fix':232,234 'flow':327 'found':141 'friend':17,270 'function':159 'functionnam':180 'get':116,119 'guidelin':8,24,150 'h1':316 'h1-h3':315 'h3':317 'header':338 'help':69 'hierarchi':318 'id':118,123,129,133 'implement':208 'index':313 'initi':227 'input':181,423 'jsdoc/tsdoc':151 'json/yaml':319 'keep':213 'key':297 'legal':71 'licens':70,105 'limit':385 'line':80,197,285 'liner':41 'link':62 'list':339 'llms.txt':273 'logic':191 'main':290 'make':252 'markdown':74,115,216,240,280 'match':394 'mcp':308 'mcp-readi':307 'mermaid':324 'min':50 'minimum':84 'mislead':356 'miss':431 'mit':106 'name':76,125,282 'need':367 'new':220 'non':199 'non-obvi':198 'object':137,286 'obvious':193,200 'occur':176 'off':266 'one':40,79,284 'one-lin':39,78,283 'order':35 'outdat':355 'output':403 'overview':384 'param':161 'paramet':124,165 'paramnam':162 'per':112 'per-endpoint':111 'permiss':424 'point':361 'port':97,99 'principl':334,335 'prioriti':34 'progress':348 'project':75,281,365 'purpos':37 'quick':45,82 'rag':312 'readi':309 'readm':9,30,72 'record':238 'refer':61,103 'releas':228 'rememb':357 'request':143 'requir':127,422 'respons':134,145 'result':179 'return':166,169 'review':415 'rout':294 'run':47,87 'safeti':425 'scannabl':337 'scope':396 'section':33,36,331 'self':203,329 'self-contain':328 'self-explanatori':202 'server':98 'show':343 'simpl':350 'skill':372,388 'skill-documentation-templates' 'source-sickn33' 'specif':410 'src/api':292 'src/index.ts':289 'start':46,83,360 'status':244 'step':85 'stop':416 'string':130 'structur':7,23,31,110,323,333 'substitut':406 'success':428 'supersed':247 'tabl':340 'task':392 'tell':347 'templat':3,5,20,21,73,114,152,212,274,358 'test':412 'throw':171 'titl':38,243 'topic-agent-skills' 'topic-agentic-skills' 'topic-ai-agent-skills' 'topic-ai-agents' 'topic-ai-coding' 'topic-ai-workflows' 'topic-antigravity' 'topic-antigravity-skills' 'topic-claude-code' 'topic-claude-code-skills' 'topic-codex-cli' 'topic-codex-skills' 'trade':265 'trade-off':264 'treat':401 'type':28,126 'typescript':153 'unreleas':218 'updat':230 'use':370,386 'user':121,132,136,139 'valid':411 'valu':170 'variabl':94 'workflow':378 'yes':131","prices":[{"id":"c0e8368f-49f1-48df-8699-3684a563307f","listingId":"316917be-797f-4a4e-8f23-2468bb1db38b","amountUsd":"0","unit":"free","nativeCurrency":null,"nativeAmount":null,"chain":null,"payTo":null,"paymentMethod":"skill-free","isPrimary":true,"details":{"org":"sickn33","category":"antigravity-awesome-skills","install_from":"skills.sh"},"createdAt":"2026-04-18T20:33:31.048Z"}],"sources":[{"listingId":"316917be-797f-4a4e-8f23-2468bb1db38b","source":"github","sourceId":"sickn33/antigravity-awesome-skills/documentation-templates","sourceUrl":"https://github.com/sickn33/antigravity-awesome-skills/tree/main/skills/documentation-templates","isPrimary":false,"firstSeenAt":"2026-04-18T21:36:16.725Z","lastSeenAt":"2026-05-18T18:50:57.542Z"},{"listingId":"316917be-797f-4a4e-8f23-2468bb1db38b","source":"skills_sh","sourceId":"sickn33/antigravity-awesome-skills/documentation-templates","sourceUrl":"https://skills.sh/sickn33/antigravity-awesome-skills/documentation-templates","isPrimary":true,"firstSeenAt":"2026-04-18T20:33:31.048Z","lastSeenAt":"2026-05-07T22:40:37.314Z"}],"details":{"listingId":"316917be-797f-4a4e-8f23-2468bb1db38b","quickStartSnippet":null,"exampleRequest":null,"exampleResponse":null,"schema":null,"openapiUrl":null,"agentsTxtUrl":null,"citations":[],"useCases":[],"bestFor":[],"notFor":[],"kindDetails":{"org":"sickn33","slug":"documentation-templates","github":{"repo":"sickn33/antigravity-awesome-skills","stars":37911,"topics":["agent-skills","agentic-skills","ai-agent-skills","ai-agents","ai-coding","ai-workflows","antigravity","antigravity-skills","claude-code","claude-code-skills","codex-cli","codex-skills","cursor","cursor-skills","developer-tools","gemini-cli","gemini-skills","kiro","mcp","skill-library"],"license":"mit","html_url":"https://github.com/sickn33/antigravity-awesome-skills","pushed_at":"2026-05-18T08:24:49Z","description":"Installable GitHub library of 1,400+ agentic skills for Claude Code, Cursor, Codex CLI, Gemini CLI, Antigravity, and more. Includes installer CLI, bundles, workflows, and official/community skill collections.","skill_md_sha":"47dbfdddfbaa090ccd55170b8fa96d601b7b448b","skill_md_path":"skills/documentation-templates/SKILL.md","default_branch":"main","skill_tree_url":"https://github.com/sickn33/antigravity-awesome-skills/tree/main/skills/documentation-templates"},"layout":"multi","source":"github","category":"antigravity-awesome-skills","frontmatter":{"name":"documentation-templates","description":"Documentation templates and structure guidelines. README, API docs, code comments, and AI-friendly documentation."},"skills_sh_url":"https://skills.sh/sickn33/antigravity-awesome-skills/documentation-templates"},"updatedAt":"2026-05-18T18:50:57.542Z"}}