Skip to content

bruce48x/Lakona / .agents/skills/lakona-doc-maintenance

lakona-doc-maintenance

Verified

Audit Lakona contributor documentation and report findings, or apply authorized cleanup to stale plans, duplicate authorities, and documentation maps within the requested scope.

FileKindSize
SKILL.mdskill md3.5 KB
agents/openai.yamlconfig281 B
references/audit-checklist.mdmarkdown4.0 KB
references/classification.mdmarkdown1.8 KB
references/operations.mdmarkdown3.6 KB

references/audit-checklist.md

View on GitHub
## Complete Quality Audit Checklist

For a full documentation audit, complete all six passes independently. Do not
stop after finding one class of problem. Record each pass as **clear**,
**findings**, or **not applicable**, and cite the files, implementation, tests,
or generated output used as evidence. For a reduced-scope audit, run every pass
that can be affected by the scoped change; do not mark a pass not applicable
without checking. Apply every checklist item within the selected scope,
including related references and authorities affected by the change. A local
correction does not require a repository-wide audit. After edits, rerun only
checks whose evidence may have changed; expand them when a finding reveals a
related problem outside the initial inventory.

1. **Factual and semantic consistency**
   - Compare claims across authoritative docs and against the implementation,
     tests, configuration, and generated output when those are the real
     evidence.
   - Verify mutable facts such as defaults, public API signatures, project
     layout, ownership, failure behavior, delivery guarantees, and runtime
     contracts.
   - Treat a consistently repeated claim as unverified until it agrees with the
     system it describes.

2. **Ownership and boundary clarity**
   - Ensure each cross-cutting contract has one clearly named authoritative
     owner and that related docs use the same boundary.
   - Check commonly confused boundaries explicitly: configuration versus
     runtime behavior, stable App code versus Hotfix code, Application HTTP
     versus Management or RPC surfaces, and cluster-wide versus endpoint-local
     concerns.
   - Resolve vague, overlapping, or contradictory ownership statements in the
     relevant authority document.

3. **Stale plans and history on the current documentation path**
   - Find completed plans, roadmaps, phase checklists, migration instructions,
     implementation diaries, resolution summaries, and superseded decisions.
   - Rewrite any still-valid rule as a present-tense contract in the relevant
     authority document.
   - Delete the remaining history-only artifact instead of moving it to an
     archive.

4. **Duplication and update fan-out**
   - Search for mutable facts copied across multiple docs, especially complete
     configuration blocks, exact API signatures, defaults, project trees, and
     generated examples.
   - Keep one canonical definition. Replace other copies with the minimum
     context needed by their readers plus a link to the authority.
   - Preserve useful explanation and deliberate terminology repetition; remove
     duplication only when it creates competing maintenance surfaces.

5. **Competing authority mechanisms**
   - Treat the documentation map in `CONTRIBUTING.md` as the sole registry of
     authoritative contributor documentation.
   - For a full audit, confirm every mapped target exists and every document
     treated as a current authority is represented in that map. For a scoped
     task, check the affected authorities and map entries, including additions,
     moves, and removals.
   - Remove document-local currentness metadata such as `Status`, `Date`,
     `Audience`, or `Last reviewed`, and remove self-declared authority labels
     that compete with the map.
   - When implementation changes architecture, configuration, public APIs,
     generated output, or runtime contracts, confirm the same change updates
     every affected authoritative document.

6. **Historical and transitional wording**
   - Review terms such as `legacy`, `old`, `removed`, `historical`, `migration`,
     `first implementation`, `current iteration`, and future-phase language.
   - Replace historical narration with the current positive contract, current
     non-goal, or current constraint.
   - Preserve wording that has present operational meaning, including protocol
     versions, active compatibility guarantees, release history, and the
     current App/Hotfix generation distinction.
   - Remove completed-resolution tables and before/after narratives when they
     no longer guide current work.
rea-analysis-optimizationmorluto/reaOptimize REA providers and shared analysis workflows for agent context, latency, CPU, and memory while preserving correctness and Evidence. Use for analysis bottlenecks and cache or query design; CI/test-suite optimization belongs to rea-ci-tests-audit.Stars: 472kUpdated Claude CodeCodexVerifiedInstall
rea-ci-tests-auditmorluto/reaAudit REA CI and test suites for correctness, fixture drift, false passes, and measured performance; use for suite or workflow investigations and efficiency changes, rather than ordinary feature testing or a single test failure.Stars: 472kUpdated Claude CodeCodexVerifiedInstall
rea-tool-designmorluto/reaAudit, investigate, design, or change REA investigation tools, CLI/MCP contracts, provider capabilities, and Evidence semantics.Stars: 472kUpdated Claude CodeCodexVerifiedInstall
ponytail-auditDietrichGebert/ponytailQuality audit of the whole repo: bugs, security, real load, missing tests, speed, and what to delete. Most important first.Stars: 194kUpdated Claude CodeCodexVerifiedInstall