{"id":"316917be-797f-4a4e-8f23-2468bb1db38b","shortId":"BfxuVv","kind":"skill","title":"Documentation Templates","tagline":"Antigravity Awesome Skills skill by Sickn33","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"],"capabilities":["skill","source-sickn33","category-antigravity-awesome-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":{"install_from":"skills.sh"}},"qualityScore":"0.300","qualityRationale":"deterministic score 0.30 from registry signals: · indexed on skills.sh · published under sickn33/antigravity-awesome-skills","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:v1","enrichmentVersion":1,"enrichedAt":"2026-04-25T11:40:44.611Z","embedding":null,"createdAt":"2026-04-18T20:33:31.048Z","updatedAt":"2026-04-25T11:40:44.611Z","lastSeenAt":"2026-04-25T11:40:44.611Z","tsv":"'-001':232 '-01':214,215 '/users':107 '1':19,80,290 '1.0.0':212 '2':82,97,294 '200':125 '2025':213,262 '3':137 '3000':90 '4':200 '404':128 '5':39,225 '6':257 '7':322 'accept':235 'action':370 'ad':209,216 'adapt':352 'adr':229,231 'agent':269 'ai':259,266 'ai-friend':258 'algorithm':185 'antigrav':3 'api':50,92,98,196,283 'applic':364 'architectur':94,226 'ask':408 'awesom':4 'behavior':191 'boundari':416 'brief':67,144,291,295 'bug':223 'busi':180 'category-antigravity-awesome-skills' 'chang':219 'changelog':201,205,207 'clarif':410 'clear':304,383 'code':138,195 'comment':139,174,175,178 'common':16 'complex':184,341 'concept':288,289,293 'configur':46,83 'consequ':250 'const':168 'contain':320 'context':238 'contract':197 'contribut':56 'core':277 'crawler':267 'criteria':419 'custom':49 'data':312 'date':344 'decid':249 'decis':227,244,245 'default':86 'depend':221 'deprec':236 'describ':371,387 'descript':71,85,118,145,153,157 'detail':54,199,339 'diagram':315 'doc':55,285 'document':1,9,17,91,99,261,286,300 'endpoint':103 'entri':281 'environ':399 'environment-specif':398 'error':165 'errortyp':162 'essenti':22 'everi':186 'exampl':132,136,167,310,331 'execut':366 'expert':404 'explan':292,296 'explanatori':194 'featur':41,78,79,81,211 'file':278 'first':332 'fix':222,224 'flow':317 'found':131 'friend':260 'function':149 'functionnam':170 'get':106,109 'guidelin':14,140 'h1':306 'h1-h3':305 'h3':307 'header':328 'help':59 'hierarchi':308 'id':108,113,119,123 'implement':198 'index':303 'initi':217 'input':171,413 'jsdoc/tsdoc':141 'json/yaml':309 'keep':203 'key':287 'legal':61 'licens':60,95 'limit':375 'line':70,187,275 'liner':31 'link':52 'list':329 'llms.txt':263 'logic':181 'main':280 'make':242 'markdown':64,105,206,230,270 'match':384 'mcp':298 'mcp-readi':297 'mermaid':314 'min':40 'minimum':74 'mislead':346 'miss':421 'mit':96 'name':66,115,272 'need':357 'new':210 'non':189 'non-obvi':188 'object':127,276 'obvious':183,190 'occur':166 'off':256 'one':30,69,274 'one-lin':29,68,273 'order':25 'outdat':345 'output':393 'overview':374 'param':151 'paramet':114,155 'paramnam':152 'per':102 'per-endpoint':101 'permiss':414 'point':351 'port':87,89 'principl':324,325 'prioriti':24 'progress':338 'project':65,271,355 'purpos':27 'quick':35,72 'rag':302 'readi':299 'readm':20,62 'record':228 'refer':51,93 'releas':218 'rememb':347 'request':133 'requir':117,412 'respons':124,135 'result':169 'return':156,159 'review':405 'rout':284 'run':37,77 'safeti':415 'scannabl':327 'scope':386 'section':23,26,321 'self':193,319 'self-contain':318 'self-explanatori':192 'server':88 'show':333 'sickn33':8 'simpl':340 'skill':5,6,362,378 'source-sickn33' 'specif':400 'src/api':282 'src/index.ts':279 'start':36,73,350 'status':234 'step':75 'stop':406 'string':120 'structur':13,21,100,313,323 'substitut':396 'success':418 'supersed':237 'tabl':330 'task':382 'tell':337 'templat':2,10,11,63,104,142,202,264,348 'test':402 'throw':161 'titl':28,233 'trade':255 'trade-off':254 'treat':391 'type':18,116 'typescript':143 'unreleas':208 'updat':220 'use':360,376 'user':111,122,126,129 'valid':401 'valu':160 'variabl':84 'workflow':368 'yes':121","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-04-25T06:51:01.737Z"},{"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-04-25T11:40:44.611Z"}],"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","source":"skills_sh","category":"antigravity-awesome-skills","skills_sh_url":"https://skills.sh/sickn33/antigravity-awesome-skills/documentation-templates"},"updatedAt":"2026-04-25T11:40:44.611Z"}}