kienbui1995/technical-writing
skills/technical-writing/SKILL.md
Use when writing documentation, READMEs, API docs, changelogs, ADRs, or user guides — ensures clarity, structure, and project consistency
development
Updated Apr 24, 2026
$ install --global
skillsauthnpx skillsauth add kienbui1995/magic-powers technical-writingInstall this skill globally with one command. Works with Claude Code, Cursor, and Windsurf.
Security Scan Results
3 of 9 scanners reported clean
Some scanners were skipped, did not run, or reported a non-clean status. Review each row below.
3
Scanners Passed
9
Scanners in report
Clean
TrivyContainer and dependency vulnerability scanner
95%
Clean
SemgrepStatic code analysis for vulnerabilities
95%
Clean
mcp-scan (Snyk)Model Context Protocol security validation
95%
Skipped
Snyk (dep)Open source security scanning
50%
Skipped
Socket.devSupply chain security analysis
50%
Skipped
VirusTotalMulti-engine malware detection
50%
Skipped
CrowdStrikeAdvanced threat intelligence
50%
Skipped
OSV-ScannerOpen Source Vulnerability database check
50%
Skipped
OWASP Dep-Check
50%
Last scanned: Apr 24, 2026, 4:18 AM142.3s1 file scanned
SKILL.md
- name:
- technical-writing
- description:
- Use when writing documentation, READMEs, API docs, changelogs, ADRs, or user guides — ensures clarity, structure, and project consistency
Technical Writing
When to Use
When creating or updating any documentation: README, API docs, architecture decision records, changelogs, user guides, onboarding docs.
Process
- Read context — scan existing docs, code, and conventions
- Identify audience — developers, end users, or ops?
- Choose format — README, ADR, API reference, tutorial, changelog
- Write draft — structure first, content second
- Verify examples — all code snippets must be runnable
Documentation Formats
README
- Project name + one-line description
- Install / quickstart (copy-pasteable)
- Usage examples
- Configuration reference
- Contributing link
API Reference
- Endpoint, method, path
- Request: headers, params, body (with types)
- Response: status codes, body schema, examples
- Error codes and meanings
ADR (Architecture Decision Record)
- Status: Proposed / Accepted / Deprecated
- Context: What problem are we solving?
- Decision: What did we choose?
- Consequences: Trade-offs, risks, follow-ups
Changelog (Keep a Changelog)
Added/Changed/Deprecated/Removed/Fixed/Security- Most recent version first
- Link to diff between versions
Rules
- Match existing project tone and terminology
- Prefer examples over explanations
- Keep sentences under 25 words
- Use active voice
- One idea per paragraph
- Use tables for structured data, lists for sequences
Related Skills
kienbui1995/xr-interface-design
content-media
VerifiedTrustedCommunity
Use when designing for XR (AR/VR/MR), choosing interaction modes, or adapting 2D UI patterns for spatial computing
SKILL.mdUpdated Apr 24, 2026
kienbui1995/writing-skills
testing
VerifiedTrustedCommunity
Use when creating new skills, editing existing skills, or verifying skills work before deployment
SKILL.mdUpdated Apr 24, 2026
kienbui1995/writing-plans
development
VerifiedTrustedCommunity
Use when you have a spec or requirements for a multi-step task, before touching code
SKILL.mdUpdated Apr 24, 2026
kienbui1995/workflow-templates
development
VerifiedTrustedCommunity
Use when executing a structured workflow — select and run a feature, bugfix, refactor, research, or incident template with correct agent and model assignments per phase.
SKILL.mdUpdated Apr 24, 2026