michalvavra/write-docs
archive/skills/write-docs/SKILL.md
Write AI-scannable technical documentation.
$ install --global
skillsauthnpx skillsauth add michalvavra/agents write-docsInstall 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: May 12, 2026, 6:07 AM154.2s1 file scanned
SKILL.md
- name:
- write-docs
- description:
- Write AI-scannable technical documentation.
Write Documentation
Documentation that is scannable, consistent, and actionable for AI agents.
Structure
- Max 150 lines per file, one concept per file
- Start with
description:in YAML frontmatter - Add TL;DR section at top with most-needed info
Content
- No duplicates (define once, link elsewhere)
- Use tables for structured data (parameters, config)
- Concrete examples for everything (copy-pasteable)
- Link to real code as templates
Naming
| Pattern | Use For | Example |
|---------|---------|---------|
| README.md | Directory overview | docs/README.md |
| {noun}.md | Reference | entities.md |
| {verb}-{noun}.md | How-to | add-entity.md |
Tips
- Use consistent terms (one term per concept)
- Group by task ("How to add X") not system ("X overview")
- Include troubleshooting for common errors
Related Skills
michalvavra/version-releases
devops
VerifiedTrustedCommunity
Use when preparing, reviewing, or documenting versioned app releases, changelogs, SemVer bumps, release commits, git tags, or tag-gated production deploys
14SKILL.mdUpdated May 12, 2026
michalvavra/architecture-review
development
VerifiedTrustedCommunity
Staff-level codebase health review. Finds monolithic modules, silent failures, type safety gaps, test coverage holes, and LLM-friendliness issues.
14SKILL.mdUpdated May 12, 2026
michalvavra/snowcli
tools
VerifiedTrustedCommunity
CLI for Snowflake. Query data, manage warehouses, databases, schemas, tables, and stages. Use when working with Snowflake data platform.
14SKILL.mdUpdated May 12, 2026
michalvavra/search-hexdocs
development
VerifiedTrustedCommunity
Search HexDocs documentation for Elixir and Erlang packages. Use when looking up package APIs or guides.
14SKILL.mdUpdated May 12, 2026