Write and revise file-based technical artifacts with ASD-STE100 controlled-English rules, evidence, repository terminology, and artifact-specific references. Use for documentation, reports, READMEs, API docs, PR text, ADRs, postmortems, and commit prose; not for chat.
Resources
1Install
npx skillscat add joaomj/pi-agent-config/technical-writing Install via the SkillsCat registry.
SKILL.md
Technical Writing
This skill owns file-based technical prose, not chat or progress updates.
- Read
references/asd-ste100.mdbefore writing prose. - Follow the repository's existing template and terminology before global
preferences. - Identify the audience, task, artifact type, and required evidence.
- Load only the relevant artifact reference:
- README:
references/readme.md - API documentation:
references/api-documentation.md - PR, ADR, and postmortem: follow the invoked prompt template.
- README:
- Preserve exact identifiers, paths, commands, versions, errors, and quoted
material. - Separate observed facts from inference. Do not invent requirements, links,
metrics, or outcomes. - Lead with the user or operational result. Keep background proportional to the
reader's task. - Remove stale claims rather than qualifying them vaguely.
- Use formal scientific-paper structure only when the user or repository asks
for it. Do not force that structure on ordinary technical documents. - Return concise prose unless the artifact requires depth.