Skip to content
cccskills
FreePublished on GitHub

documentation-and-adrs

Writes or updates engineering documentation and architecture decision records from repository facts, explicit assumptions, trade-offs, and verification links. Use for README changes, design docs, runbooks, ADRs, migration notes, and contributor documentation. Not for implementation planning alone or for copying external documentation without provenance.

The English summary is being prepared. Showing the original description.

See how to install

Files included (2)

  • SKILL.md1.7 KB
  • references/adr-template.md520 B

SKILL.md (original)

Review the instructions the agent will receive before you install.

Documentation and ADRs

Document the decision a future maintainer needs, not the whole conversation.

Documentation workflow

  1. Identify the reader, decision or task, freshness owner, and expected action.
  2. Inspect the source of truth, commands, configuration, and current behavior.
  3. Separate facts, assumptions, examples, and recommendations. Mark version or environment-specific statements.
  4. Put the shortest usable path first; move exhaustive details to a linked reference.
  5. Test every command, code sample, relative link, and stated file path that the environment permits.

ADR workflow

Use an ADR when a choice affects interfaces, architecture, data, operations, security, or future contributors. Record context, decision, alternatives, consequences, rejected options, migration/rollback, and status. Do not use an ADR to hide an unresolved decision; mark it proposed or superseded honestly.

Read adr-template.md. Keep README content as a front door and link to deeper docs; avoid stale feature walls and hardcoded claims that the repository cannot verify.

Completion condition

The intended reader can act from the document, links and examples resolve, and the document's factual or verification limits are visible.

Reviews

No reviews yet. Tell others what you thought.

Comments

No login needed. Share how it worked for you, ask a question, or note where it did not run.

No comments yet. Be the first to write one.

Comments are published right away. Do not include personal information such as email addresses or phone numbers. Up to 2 URLs.

0 / 1,000 characters

This form is protected by reCAPTCHA, and the Google Privacy Policy and Terms of Service apply.

More skills from this repository

Designs and runs reproducible evaluations for AI agents, prompts, tools, skills, and model-backed workflows using realistic datasets, isolated baselines, objective assertions, rubric grading, trajectory analysis, cost/latency tracking, and regression comparison. Use when measuring agent quality, optimizing skill triggering, comparing prompts or models, or gating an AI feature release. Not for ordinary deterministic unit tests.

The English summary is being prepared. Showing the original description.

thiientv/godmode99Updated Aug 26, 2026

Designs or reviews HTTP, REST, GraphQL, RPC, CLI, webhook, event, and service interfaces with explicit inputs, outputs, errors, compatibility, idempotency, pagination, authentication, versioning, and observability. Use when introducing or changing an API or cross-component contract. Not for internal implementation details with no boundary or for debugging one API failure; use root-cause-debugging there.

The English summary is being prepared. Showing the original description.

thiientv/godmode99Updated Aug 26, 2026

Reviews an existing codebase for structural friction, unclear ownership, leaky or shallow interfaces, excessive coupling, misplaced state, poor testability, and risky dependency direction, then prioritizes evidence-backed improvement candidates. Use for architecture audits, modularization, modernization, or recurring cross-cutting change pain. Not for designing one new interface, simplifying a local function, or fixing a reproduced bug.

The English summary is being prepared. Showing the original description.

thiientv/godmode99Updated Aug 26, 2026

Validates a running application, CLI, API, service, or generated artifact as a user or operator against a prewritten observable behavior contract while remaining source-blind. Use for acceptance checks, runtime proof, anti-fake probes, release smoke tests, or an independent companion to code review. Not for source-quality findings, root-cause diagnosis, or visual design judgment outside the contract.

The English summary is being prepared. Showing the original description.

thiientv/godmode99Updated Aug 26, 2026

Closes a completed development branch by checking the final diff and proof, presenting merge, pull-request, keep, or discard options, and cleaning up only after the user or repository workflow chooses a path. Use when feature work is complete and the branch must be integrated or retired. Not for claiming a feature is complete before verification.

The English summary is being prepared. Showing the original description.

thiientv/godmode99Updated Aug 26, 2026

Tests a real web user flow with a browser by asserting semantic behavior, network and loading states, keyboard access, responsive layouts, and stable visual evidence. Use for browser bugs, end-to-end UI behavior, responsive or accessibility checks, and screenshot baselines. Not for static source review without a browser or for backend-only tests.

The English summary is being prepared. Showing the original description.

thiientv/godmode99Updated Aug 26, 2026

See all skills by thiientv

Report a problem with this skill