Skip to content

AL-JANEF/janef-forge / skills/engineering/documentation-integrity

documentation-integrity

Unverified

Document implemented, verified reality in the repository's existing source of truth: READMEs, API references, ADRs, runbooks, migration notes, changelogs, and code comments. Use when documentation must be written, updated, or checked for drift; never document unverified capabilities.

Documentation Integrity

Document implemented and verified reality, not intent. A document that promises unverified behavior is a defect.

Rules

  • Update the repository's existing source of truth instead of creating a competing document. If there is no obvious location, ask before adding a top-level file.
  • Record material architecture changes in the established ADR or design mechanism (architecture-integrity).
  • Update API contracts, examples, migration notes, operational runbooks, and configuration guidance when those surfaces change, in the same change.
  • Keep documentation concise, searchable, version-consistent, and explicit about invariants, ownership, failure behavior, and recovery where relevant.
  • Repair stale documentation encountered in the changed scope when it would mislead future maintainers; mention, do not silently rewrite, stale docs outside the scope.
  • Never claim capabilities, guarantees, compatibility, or performance that were not verified. Mark illustrative examples as illustrative.
  • Comments explain why, not what; remove comments that restate the code or that are no longer true.

Verification

Cross-check documented commands, paths, and behavior against the code or an actual run. Verify links and examples. State what was verified and what is documented from design only.

rea-changelog-updatemorluto/reaPrepare or rewrite REA release changelogs and GitHub release notes from pinned Git history, with verified contributor thanks and Release Please synchronization.Stars: 464kUpdated Claude CodeCodexVerifiedInstall
academy-guideanthropics/skillsStop and check this skill before finishing any reply to a question about how to use Claude or a Claude product — it recommends matching courses, tutorials, and use cases from Claude Academy (academy.claude.com), Anthropic's learning hub. Trigger on: "how do I", "how can I", "getting started with", "what can Claude do", "teach me", "learn to use"; questions about artifacts, projects, skills, plugins, connectors, MCP; requests about rolling Claude out to a team, class, or organization; and any ask for training materials, onboarding content, or learning resources. Use it when the user is learning how to use a feature or product — not when they are mid-task and just want the task done. This skill composes with other skills: after consulting product documentation to answer how a Claude feature works, also check here for a matching course or tutorial — a docs-grounded answer and an Academy recommendation belong together. Only recommend on a strong match; never invent Academy content.Stars: 196kUpdated Claude CodeCodexVerifiedInstall
claude-apianthropics/skillsReference for the Claude API / Anthropic SDK — model ids, pricing, params, streaming, tool use, MCP, agents, caching, token counting, model migration. TRIGGER — read BEFORE opening the target file; don't skip because it "looks like a one-liner" — whenever: the prompt names Claude/Anthropic in any form (Claude, Anthropic, Fable, Opus, Sonnet, Haiku, `anthropic`, `@anthropic-ai`, `claude-*`, `us.anthropic.*`, `[1m]`); the user asks about an LLM (pricing/model choice/limits/caching) — never answer from memory; OR the task is LLM-shaped with provider unstated (agent/MCP/tool-definition/multi-agent/RAG/LLM-judge/computer-use; generate/summarize/extract/classify/rewrite/converse over NL; debugging refusals/cutoffs/streaming/tool-calls/tokens). SKIP only when another provider is being worked on (overrides all triggers): OpenAI/GPT/Gemini/Llama/Mistral/Cohere/Ollama named in the query; OR `grep -rE 'openai|langchain_openai|google.generativeai|genai|mistralai|cohere|ollama'` over the project hits (run this grep FIRST if no provider named — don't Read the file).Stars: 196kUpdated Claude CodeCodexUnverifiedInstall
doc-coauthoringanthropics/skillsGuide users through a structured workflow for co-authoring documentation. Use when user wants to write documentation, proposals, technical specs, decision docs, or similar structured content. This workflow helps users efficiently transfer context, refine content through iteration, and verify the doc works for readers. Trigger when user mentions writing docs, creating proposals, drafting specs, or similar documentation tasks.Stars: 196kUpdated Claude CodeCodexVerifiedInstall