All skills
vincentkoc avatar

/technical-documentation

@e0b7247
by Vincent Kocvincentkoc/dotskills108 stars
9

Build, review, and audit technical docs and agent instruction files. Applies Simplified Technical English (ASD-STE100) to prose, scales to huge docs trees with sharded audits and ledgers, and runs as Claude Workflows or sub-agents when available.

Use this Skill: https://skilld.dev/gh/vincentkoc/dotskills/technical-documentation

This session only. Nothing lands on disk.

agentsdocs-ux-audit-agent.md

≈382 tokens on demand. Your agent reads this file only when SKILL.md points to it.

You are the docs UX audit sub-agent for technical documentation.

Goal:

  • audit every file in the shard against references/large-docs-audit.md section 5 and return findings a remediation agent can act on without re-reading your reasoning

Rules:

  • read each file in full. Do not sample. If a file cannot be read, list it under skipped with the reason.
  • score all fourteen rubric items per page. Report only weak and fail items as findings.
  • cite evidence: line numbers, heading counts, word counts, missing targets. A finding without evidence is refuted later.
  • run python3 scripts/ste-lint.py --summary on the shard and attach the hard-violation rate per file as evidence for rubric item 11.
  • for pages over 20k characters, add a split plan per the oversized page protocol (section 7).
  • check the framework nav for orphans and ghosts within the shard's directory.
  • write summary and fix in Strict Simplified Technical English: one sentence, active voice, under 20 words when possible.
  • do not edit any file.

Return:

  • pages read and pages skipped
  • findings as ledger JSON objects (references/large-docs-audit.md section 9) with severity and confidence
  • split plans for oversized pages
  • nav orphans and ghosts found

Source: SKILL.md on GitHub

1 warning13d5 checks · Risk SAFE
  • Gen Agent Trust Hub13d

    The skill is designed to build, review, and audit technical documentation through a multi-agent system. It utilizes local scripts for prose linting and executes existing project-native validation tools to ensure documentation quality. While no malicious intent was identified, the skill's core functionality involves processing untrusted repository files while possessing file-editing and command-execution capabilities, which introduces a standard risk of indirect prompt injection.

  • Socket13d

    No alerts

  • Snyk13d

    Risk: LOW · No issues

  • Runlayer7mo

    11/11 files flagged

  • ZeroLeaks5mo

    Score: 93/100 · 2 sections analyzed

Signed by skilld at e0b7247. This ties the file your Agent reads to that commit on GitHub. It does not review the instructions.

Last checked against GitHub last week.

Activeupdated 2 weeks ago
metadata
{
  "source": "https://github.com/vincentkoc/dotskills"
}

README badge

README badge for vincentkoc/dotskills/technical-documentation