doc-gen
/doc-gen
Generuje dokumentację z kodu źródłowego: docstringi, pliki README i referencje API.
- Autor
- smart-ai-memory ↗
- Repozytorium
- attune-ai ↗
- Licencja
- Apache-2.0
- Ostatnia zmiana repozytorium
- 24.10.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 24.10.2026, bez odwołań do wycofanych modeli i API.
Apache-2.0, otwarta: można używać i zmieniać, z zachowaniem licencji i informacji o zmianach.
Co robi i kiedy
Generuje dokumentację z kodu źródłowego: docstringi, pliki README i referencje API.
Oryginalny opis (EN)
Generate documentation from source code — docstrings, READMEs, API references. Triggers on: generate docs, write documentation, document this, create README, API docs, doc-gen.
Jak działa
- Scoping
- MCP Tools
- Execution
- Output Format
- Help
- Follow-Up
Podgląd SKILL.md
--- name: doc-gen description: "Generate documentation from source code — docstrings, READMEs, API references. Triggers on: generate docs, write documentation, document this, create README, API docs, doc-gen." --- # Doc Gen **IMPORTANT: Start your response with a context preamble.** Call `help_lookup(topic="doc-gen", mode="preamble")` and display the returned `preamble` text as a blockquote. Then tell the user they can say "tell me more" for a step-by-step guide, or answer the scoping questions below to proceed. If the MCP call fails, fall back to: > **Doc Gen** — Generates documentation from your source code — docstrings, README sections, API references. ## Scoping Before running, ask: 1. **Target**: "Which file or module needs documentation?" 2. **Type**: "What kind of docs?" - Docstrings — Add or update Google-style docstrings - README — Generate a README section for a module - API reference — Generate full API documentation - Overview — High-level module explanation ## MCP Tools | Tool | What It Does | | ---- | ------------ | | `doc_gen` | Generate documentation for a module | | `doc_audit` | Check for stale or missing docs | | `doc_orchestrator` | Full documentation maintenance pipeline | ## Execution ### Shared command workspace (preferred) Open adapter `doc-gen` with the validated target and documentation type. Run the bound read-only `doc_audit` action first and publish `audit_result` with the exact proposed artifact paths. Present the proposal widget or Markdown; only an explicitly confirmed `apply_docs` action authorizes those paths. After `doc_gen`, publish `generation_result` with the exact files reported from disk. The adapter hashes them independently and rejects writes outside or different from the approved set. Run the returned `doc-import-audit`/symbol reality probe and publish its exact command and outcome as `validation_result`. A partial write or failed reality probe must say “did not complete” and retain changed-file hashes for rollback. Preserve these gates and receipts in compact text when the shared tools are unavailable. For docstring generation: ``` doc_gen(source_path="<target module>") ``` For a full documentation audit first: ``` doc_audit(path="<target>") ``` Then generate docs for gaps found: ``` doc_gen(source_path="<gap file>") ``` For a complete pipeline (audit + generate + review): ``` doc_orchestrator(path="<target>") ``` ## Output Format **Prefer the rich panel.** If the tool response includes `panel_html`, pass it to `mcp__visualize__show_widget` — the universal report panel (title, score, findings/category sections; from `attune.workflows.report_panel`). It shows an explicit "did not complete" state on failure, never a false "clean". Fall back to the markdown below when the widget surface is unavailable. ```markdown ## Documentation Report **Files:** X | **Functions Documented:** Y | **Gaps:** Z ### Generated Docstrings | File | Function | Status | |------|----------|--------| ### Gaps Remaining | File | Missing | |------|---------| ``` ## Help After presenting results, call: ``` help_lookup(topic="doc-gen", mode="workflow_help") ``` If templates are returned, offer: "I have tips about documentation generation — want to see them?" ## Follow-Up After presenting results, offer: - "Want me to apply these docstrings to the files?" - "Should I audit the rest of the project?" - "Want a README section generated from this?"
Wersje
W bazie nie ma innych skilli o nazwie doc-gen.
Identyczna treść występuje jeszcze w 1 innych folderach na GitHubie. Tu pokazujemy jedną, najlepiej ocenioną kopię.
Migawka bazy z 13.11.2026 · wersja paczki ff44ef9462f5 (skrót SHA-256 całej paczki)
Pobrania w ostatnich 30 dniach: 3 · ranking
Zgłoś problem z tym skillem: szkodliwa treść, błędny opis albo prośba autora o usunięcie.
Podobne skille
- 100code-documentation
Generuje dokumentację baz kodu: referencje API, docstringi, pliki README i przewodniki użycia. - 100documentation
Generuje docstringi, JSDoc, dokumentację API i aktualizacje README, które odzwierciedlają bieżący kod. - 100documentation-generation
Generuje dokumentację projektu: README, docstringi (JSDoc, JavaDoc, Python), opisy OpenAPI i potoki dokumentacji w CI/CD. - 100doc-generation
Generuje dokumentację kodu tradingowego i finansowego: opisy strategii, referencje API, przykłady użycia, pliki README i komentarze w kodzie. - 100documenting-projects
Generuje, poprawia i audytuje dokumentację projektu: README, tutoriale, referencje API i przegląd dokumentacji, także gdy dokumentacja jest nieaktualna. - 100documentation-generator
Generuje dokumentację bazy kodu na podstawie repozytorium: README, dokumentację API, dokumenty architektury i referencje techniczne dla istniejącego projektu.