agentleFS
Sign inStart free
hamzzaqureshihamzzaqureshi/gravidex/.agents/skills/technical-documentation/SKILL.md

technical-documentation

Skill1 starsChanged 7 days agoMITView on GitHub

Author and maintain professional technical documentation, repository READMEs, Architectural Decision Records (ADRs), codebase onboarding guides, and Git collaboration workflows. Enforces README-driven development (50-point scorecard), humanized anti-AI prose polishing, and clean conventional commits.

33 other projects use a version of this.

Adopted by

Most recently taken up by

Used with

Projects with it also use clawhub-ban-appeals, clawhub-clawscan and 10 more.

Other files people use alongside this one.

Files found in the same public projects as a version of this one, more often than they turn up anywhere else. Each project counts once, large collections count for less, and this file's own repository is left out.
  • openclawSkill

    clawhub-ban-appeals

    Review ClawHub account-ban appeals, distinguish bans from moderation holds or blocked releases, and prepare an evidence-backed moderation decision. Route validated scanner inaccuracies to clawhub-clawscan.

    Also in 3 projects that use this

  • openclawSkill

    clawhub-clawscan

    Investigate ClawScan health alerts, diagnose scanner or ClawHub integration failures, prepare operational repairs, and route validated verdict inaccuracies upstream. Account ban appeals use clawhub-ban-appeals.

    Also in 3 projects that use this

  • FabienGreardSkill

    convex-acquire-domain

    Find and buy a domain for the current Convex app through Convex, then bind it (labs; spend action).

    Also in 3 projects that use this

  • +9 more from openclaw

The file

We split this skill into the rules it gives an agent

1 rule. 0 are common, 0 are distinctive, and 1 is very specific to this project.

  • 0

    Common

    Most of the 31 edited versions we read keep these.

  • 0

    Distinctive

    This author's own choices. Worth a look.

  • 1

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Very specific:

    Document project entry points and conventions.

    line 44

“Common” is measured: kept by at least 6 in 10 of the 31 edited versions of this file we could read. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.md

Technical Documentation

Consolidated capability for authoring production repository READMEs, Architectural Decision Records (ADRs), codebase onboarding maps, polished human prose, and clean Git workflows.

When to Activate

  • Writing, auditing, or refactoring GitHub READMEs across 5 project archetypes.
  • Recording architectural decisions as numbered ADRs with trade-off analysis.
  • Onboarding to an unfamiliar codebase and generating architecture entrypoint guides.
  • Polishing AI-generated documentation to eliminate generic filler, buzzwords, and AI tells (Humanizer).
  • Formulating conventional commit messages, PR descriptions, and Git branching workflows.
  • Enforcing cross-language coding standards (naming, file organization, immutability).

When NOT to Activate

  • Authoring unit or integration test suites (use quality-engineering).
  • Writing system architecture code (use backend-engineering or frontend-engineering).

Core Execution Workflow

  1. README-Driven Development:
    • Guide the reader's journey: Discover -> Understand -> Start -> Use/Contribute.
    • Audit READMEs against the 50-point quality scorecard.
    • Consult references/readme-driven-development.md.
  2. Architectural Decision Records (ADR):
    • Record significant technical choices in docs/adr/NNNN-decision.md covering context, alternatives considered, decision, consequences, and status. Maintain index README.
    • Consult references/architecture-decision-records.md.
  3. Prose Polishing (Humanizer):
    • Eliminate AI writing tells: staged openers, forced triads, excessive em-dashes, and buzzword padding.
    • Consult references/humanizer-editorial-guide.md.
  4. Codebase Onboarding & Git Workflow:
    • Document project entry points and conventions. Enforce clean conventional commits (feat:, fix:, docs:, test:, refactor:, chore:).
    • Consult references/codebase-onboarding.md and references/git-collaboration-workflow.md.

Modular Reference Directory

Reference ModulePrimary FocusSource Provenance
readme-driven-development.md50-point quality scorecard, reader journey, 5 project archetypeshamzzaqureshi/gravidex (writing-readme)
architecture-decision-records.mdNumbered ADR authoring, alternatives, consequences, index READMEaffaan-m/ECC (architecture-decision-records)
humanizer-editorial-guide.md26-pattern anti-AI prose polishing, eliminating corporate fillerhamzzaqureshi/gravidex (humanizer)
codebase-onboarding.mdUnfamiliar codebase analysis, architecture map, starter CLAUDE.mdaffaan-m/ECC (codebase-onboarding)
git-collaboration-workflow.mdConventional commits, PR workflows, clean local historyaffaan-m/ECC (git-workflow)
coding-standards.mdBaseline cross-project naming, readability, immutability conventionsaffaan-m/ECC (coding-standards)

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

Check your setup, free