documentation-templates
/documentation-templates
Dostarcza struktury szablonów dla README, dokumentacji API, komentarzy w kodzie, changelogów i llms.txt przy pisaniu dokumentacji projektu.
- Autor
- jeffersonvalente ↗
- Repozytorium
- cardume ↗
- Licencja
- MIT
- Ostatnia zmiana repozytorium
- 04.11.2026
Ocena i bezpieczeństwo
- Pliki w paczce
- 1
- Skrypty
- 0
- Komentarze HTML
- 0
- Adresy URL w SKILL.md
- 0
Brak sygnałów. Repozytorium zmienione 04.11.2026, bez odwołań do wycofanych modeli i API.
MIT, otwarta: można używać i zmieniać, z zachowaniem informacji o autorze.
Co robi i kiedy
Dostarcza struktury szablonów dla README, dokumentacji API, komentarzy w kodzie, changelogów i llms.txt przy pisaniu dokumentacji projektu.
Oryginalny opis (EN)
Structure templates for READMEs, API docs, code comments, changelogs and llms.txt. Use when writing or restructuring project documentation.
Jak działa
- 1. README Structure
- 2. API Documentation Structure
- 3. Code Comment Guidelines
- 4. Changelog Template (Keep a Changelog)
- 5. Architecture Decision Record (ADR)
- 6. AI-Friendly Documentation (2025)
- 7. Structure Principles
Podgląd SKILL.md
--- name: documentation-templates description: "Structure templates for READMEs, API docs, code comments, changelogs and llms.txt. Use when writing or restructuring project documentation." allowed-tools: Read Glob Grep --- # 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 ```markdown # Project Name Brief one-line description. ## Quick Start [Minimum steps to run] ## Features - Feature 1 - Feature 2 ## Configuration | Variable | Description | Default | |----------|-------------|---------| | PORT | Server port | 3000 | ## Documentation - [API Reference](./docs/api.md) - [Architecture](./docs/architecture.md) ## License UNLICENSED ``` --- ## 2. API Documentation Structure ### Per-Endpoint Template ```markdown ## GET /users/:id Get a user by ID. **Parameters:** | Name | Type | Required | Description | |------|------|----------|-------------| | id | string | Yes | User ID | **Response:** - 200: User object - 404: User not found **Example:** [Request and response example] ``` --- ## 3. Code Comment Guidelines ### JSDoc/TSDoc Template ```typescript /** * Brief description of what the function does. * * @param paramName - Description of parameter * @returns Description of return value * @throws ErrorType - When this error occurs * * @example * const result = functionName(input); */ ``` ### When to Comment | ✅ Comment | ❌ Don't Comment | |-----------|-----------------| | Why (business logic) | What (obvious) | | Complex algorithms | Every line | | Non-obvious behavior | Self-explanatory code | | API contracts | Implementation details | --- ## 4. Changelog Template (Keep a Changelog) ```markdown # Changelog ## [Unreleased] ### Added - New feature ## [1.0.0] - 2025-01-01 ### Added - Initial release ### Changed - Updated dependency ### Fixed - Bug fix ``` --- ## 5. Architecture Decision Record (ADR) ```markdown # ADR-001: [Title] ## Status Accepted / Deprecated / Superseded ## Context Why are we making this decision? ## Decision What did we decide? ## Consequences What are the trade-offs? ``` --- ## 6. AI-Friendly Documentation (2025) ### llms.txt Template For AI crawlers and agents: ```markdown # Project Name > One-line objective. ## Core Files - [src/index.ts]: Main entry - [src/api/]: API routes - [docs/]: Documentation ## Key Concepts - Concept 1: Brief explanation - Concept 2: Brief explanation ``` ### MCP-Ready Documentation For RAG indexing: - Clear H1-H3 hierarchy - JSON/YAML examples for data structures - Mermaid diagrams for flows - Self-contained sections --- ## 7. Structure Principles | Principle | Why | |-----------|-----| | **Scannable** | Headers, lists, tables | | **Examples first** | Show, don't just tell | | **Progressive detail** | Simple → Complex | | **Up to date** | Outdated = misleading | --- > **Remember:** Templates are starting points. Adapt to your project's needs.
Wersje
| Repozytorium | Wynik | Licencja |
|---|---|---|
| Ta strona · jeffersonvalente/cardume | 100 | MIT |
| Reprograme/redevkit | 100 | MIT |
Migawka bazy z 13.11.2026 · wersja paczki c49cb17c2ca6 (skrót SHA-256 całej paczki)
Pobrania w ostatnich 30 dniach: 0 · ranking
Zgłoś problem z tym skillem: szkodliwa treść, błędny opis albo prośba autora o usunięcie.
Podobne skille
- 100deep-documentation
Tworzy, rozszerza, reorganizuje i utrzymuje dokumentację repozytorium: README, przeglądalne dokumenty, strony API, llms.txt, llms-full.txt, changelogi i lokalne skille agentów uczące korzystania z dokumentacji. - 100documentation-patterns
Opisuje wzorce dokumentacji technicznej dla README, ADR, API w OpenAPI 3.1, changelogów i przewodników stylu pisania. - 100documentation-patterns
Podaje wzorce dokumentacji technicznej: README, ADR, changelogi, API w OpenAPI 3.1 i styl pisania przy tworzeniu dokumentacji projektu. - 100documentation
Prowadzi przy pisaniu dokumentacji technicznej: pliki README, dokumentacja API, przewodniki i dokumentacja w kodzie. - 100documentation-patterns
Dostarcza szablony i wzorce struktury dla dokumentacji API, funkcji, przewodników konfiguracji i endpointów REST, w formie szablonów Markdown. - 100documentation
Dostarcza szablony i wzorce dla README, dokumentacji API, ADR i przewodników użytkownika, wywoływane przy zadaniach dokumentacyjnych.