/documentation-standard

← Vissza az áttekintéshez

Összefoglaló

Átfogó dokumentációkezelés szoftverprojektekhez — architektúra-dokumentumok, ADR-ek, felhasználói kézikönyvek és fejlesztői útmutatók létrehozása, frissítése, rendszerezése és átstrukturálása előírt struktúra, elnevezési konvenciók és tartalmi szabványok mentén.

Mikor használd

A /documentation-standard parancsot a projektdokumentáció bármely szakaszában használd: nulláról induláshoz, meglévő dokumentumok minőségi és konzisztencia-auditjához, struktúra átszervezéséhez, vagy dokumentációk review-jához PR vagy sprint keretében. Lefedi a könyvtárszerkezetet, a fájlnévkonvenciókat, a metaadat-fejléceket, az írásstílust, a diagramformátumot (Mermaid) és a karbantartási folyamatokat.

Triggerkifejezések (a SKILL.md-ből):

Meghívás

Slash parancsként hívd meg, opcionálisan a dokumentációs feladat leírásával:

/documentation-standard [description of the documentation task]

Tipikus célpontok: egy meglévő /Documentation/ mappa auditálása, új architektúra-dokumentum készítése, ADR megfogalmazása vagy egy teljes dokumentáció-refaktorálási kérés. A skill az általad megadott célpontra alkalmazza a szabványos könyvtárszerkezetét, elnevezési konvencióit és minőségi ellenőrzőlistáját.

1. példa — Új architektúra-dokumentum készítése

Bemenet:

/documentation-standard Create a new architecture document for our caching strategy. Backend and infra engineers are the audience.

Kimenet / Eredmény:

Creating: Documentation/Architecture/170_caching_strategy.md

Metadata header added:
  Purpose: Defines caching layers and invalidation strategies
  Audience: Backend and infrastructure engineers
  Status: Draft
  Last reviewed: 2026-06-05
  Next review: 2026-09-05

Structure applied:
  ## Principles
  1. Cache close to the data source
  2. Invalidate explicitly, not by TTL
  3. Monitor cache hit rates

  ## Overview
  ...  (remaining content authored here)

Index updated: 990_documentation_index_and_contribution_guide.md

2. példa — Meglévő dokumentáció auditálása és átstrukturálása

Bemenet:

/documentation-standard Audit the Documentation/ folder. We have a lot of files added over time — naming might be inconsistent, some docs may lack metadata headers, and cross-references are probably stale.

Kimenet / Eredmény:

Audit complete. Issues found:

Naming violations (3 files):
  - api_docs.md → rename to 600_api_reference_or_public_interface.md
  - ErrorHandling.md → rename to 140_error_handling_strategy.md
  - readme_services.md → move to Architecture/, rename to 120_services_and_integration_architecture.md

Missing metadata headers (5 files):
  - testing_strategy.md, performance.md, ... (details listed)

Broken cross-references (2 links):
  - 100_system_architecture_overview.md links to deleted services_v1.md

No duplicated content detected.
Diagrams: 2 PNG screenshots found — recommend converting to Mermaid.

Suggested actions: rename 3 files, add metadata to 5, fix 2 links, convert 2 diagrams.

Kapcsolódó eszközök