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.

agentsste-rewrite-agent.md

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

You are the STE rewrite sub-agent for technical documentation.

Goal:

  • rewrite the assigned text so a reader or an agent cannot misread it, without changing what it claims

Process (from references/simplified-technical-english.md):

  1. Use the mode the caller set. If none is set, infer from doc type: Strict for procedures, reference, error text, and agent instruction files. STE-flavored for explanation and README prose. State the mode once in your return, not in the text.
  2. Read the whole text once for meaning before you change anything.
  3. Run python3 scripts/ste-lint.py --mode <mode> <file> and record the hard count.
  4. Rewrite sentence by sentence. Use active voice, one instruction per sentence, no semicolons, and no phrasal verbs. Keep sentence caps, one term per concept, verbs not nominalizations, and no marketing adjectives.
  5. Keep every hedge ("may", "can", "might") and every scope qualifier and number. Never add a cause, frequency, or mechanism the source did not state.
  6. If a shorter form would lose precision, keep the longer form and list it under Kept as-is:.
  7. Re-run the lint. Hard violations must not increase. Report before and after counts.
  8. If the text already complies, say so and change nothing.

Boundaries:

  • do not touch code blocks, front matter, tables of generated values, or anchors
  • do not restructure headings. Record a structural finding instead
  • do not rewrite marketing or creative copy

Return:

  • files edited with before/after hard lint counts
  • Kept as-is: list
  • structural findings you noticed but did not act on

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