Przejdź do treści
Biblioteka skilli
Programowanie · Pisanie

docgen

/docgen

Generuje dokumentację: opisy API, moduły i komponenty, treść README i przewodniki, także dla wielu plików z jawnym śledzeniem pokrycia.

Repozytorium
flow ↗
Licencja
Apache-2.0
Ostatnia zmiana repozytorium
26.09.2026

Ocena i bezpieczeństwo

100/ 100Klasa: dobry
Format25 / 25
Frontmatter z nazwą i opisem, poprawna nazwa, opis do 1024 znaków, nazwa zgodna z folderem.
Odkrywalność25 / 25
Opis mówi, kiedy użyć skilla, ma sensowną długość i jest w 3. osobie.
Treść35 / 35
Co najmniej 150 słów i do 500 linii, nagłówki, listy kroków, przykłady albo kod.
Higiena15 / 15
Bez zaślepek typu TODO, bez ścieżek Windows, z licencją.
Ryzykobrak sygnałów w skanie
Pliki w paczce
4
Skrypty
0
Komentarze HTML
0
Adresy URL w SKILL.md
0
Przestarzałość

Brak sygnałów. Repozytorium zmienione 26.09.2026, bez odwołań do wycofanych modeli i API.

Licencja

Apache-2.0, otwarta: można używać i zmieniać, z zachowaniem licencji i informacji o zmianach.

Co robi i kiedy

Generuje dokumentację: opisy API, moduły i komponenty, treść README i przewodniki, także dla wielu plików z jawnym śledzeniem pokrycia.

Oryginalny opis (EN)

Use when generating documentation, writing API docs, documenting modules or components, creating README content, building reference guides, or documenting many files with explicit coverage tracking.

Jak działa

  1. Workflow
  2. Guardrails
  3. Output
  4. Validation
  5. Example
  6. References
Sekcje z nagłówków SKILL.md, w oryginale · 60 linii, 214 słów
Podgląd SKILL.md
---
name: docgen
description: "Use when generating documentation, writing API docs, documenting modules or components, creating README content, building reference guides, or documenting many files with explicit coverage tracking."
---

# Docgen

Generate complete documentation from inspected source with explicit coverage
tracking. Use standalone or as the analysis engine for Flow documentation work.

<workflow>

## Workflow

1. Load the documentation strategy and component template below.
2. Execute the manifest-driven coverage workflow against the exact source scope.
3. Cross-reference the documented components and synthesize the requested
   consumer-facing document.

</workflow>

<guardrails>

## Guardrails

Read every in-scope file. Do not infer behavior from names, skip small files,
or claim completeness while manifest entries remain unresolved. Write direct,
evidence-backed technical prose: never use AI puffery (`seamless`, `robust`,
`comprehensive`, `pivotal`, `delve`, `leverage`), negative parallelisms (`"not
just X, but Y"`), formulaic transitions (`"Moreover"`, `"Furthermore"`),
superficial participle tails (`"...ensuring reliability"`), or boldface-bullet
padding. Lead every section with concrete file paths, symbols, and invariants.

</guardrails>

## Output

Return the completed/total manifest count, module overview, scaled
per-component documentation, verified cross-references, usage examples, and a
dependency map when the scope contains multiple components.

<validation>

## Validation

Confirm every manifest item is covered and every documentation claim comes
from freshly inspected source.

</validation>

<example>

## Example

For a four-file module, report `[4/4 files documented]`, describe each public
interface, and show the verified dependency direction between components.

</example>

## References

- [Docgen strategy](references/docgen-strategy.md) — coverage workflow and progress rules.
- [Component template](references/component-template.md) — generated document structure.
Pliki w paczce (4)
  • SKILL.md 2 KB
  • agents/openai.yaml 1 KB
  • references/component-template.md 2 KB
  • references/docgen-strategy.md 2 KB

Wersje

RepozytoriumWynikLicencja
Ta strona · cofin/flow100Apache-2.0
harnessprotocol/harness-kit100Apache-2.0
tsaol/awesome-claude100MIT
AsiaOstrich/universal-dev-standards95MIT
AsiaOstrich/universal-dev-standards95MIT

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 2e059c64d4be (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

  • 100code-documentation
    Pomaga pisać dokumentację kodu: README, dokumentację API, komentarze i przewodniki dla programistów.
  • 100agent-documentation-writer
    Generuje dokumentację: README, dokumentację API, dokumenty architektury i komentarze w kodzie, a także przewodniki i opisy systemów.
  • 100documenting-projects
    Generuje, poprawia i audytuje dokumentację projektu: README, tutoriale, referencje API i przegląd dokumentacji, także gdy dokumentacja jest nieaktualna.
  • 100documentation-guide
    Prowadzi przez strukturę i wymagania dokumentacji projektu oraz dobre praktyki: README, folder docs, CONTRIBUTING, CHANGELOG, ARCHITECTURE i dokumentacja API.
  • 100documentation
    Prowadzi przy pisaniu dokumentacji technicznej: pliki README, dokumentacja API, przewodniki i dokumentacja w kodzie.
  • 85odoo_module_documentation
    Pomaga dokumentować moduły Odoo: zrzuty ekranu, przewodniki dla użytkowników i dokumentację techniczną.

Uwagi i zgłoszenia

Wiadomość trafi do Bartosza Sokolińskiego. Adres e-mail jest potrzebny tylko do odpowiedzi. Szczegóły w polityce prywatności.