jimweller/configs/claude-code/skills/md-style
configs/claude-code/skills/md-style/SKILL.md
--- name: md-style description: README style guide for concise, direct documentation. Use when writing or editing README files. ß--- <!-- markdownlint-disable-file MD041 --> # README Style Guide Write concise, direct README files for experienced engineers. ## Principles - **No fluff** - Skip tables of contents, verbose explanations, development history - **No roadmaps** - Document current state only, not plans or decisions. Readme is an engineering specification. Not a project plan or chan
development
Updated Apr 30, 2026
$ install --global
skillsauthnpx skillsauth add jimweller/dotfiles configs/claude-code/skills/md-styleInstall 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 30, 2026, 7:06 AM7.6s1 file scanned
SKILL.md
name: md-style description: README style guide for concise, direct documentation. Use when writing or editing README files. ß---
<!-- markdownlint-disable-file MD041 -->README Style Guide
Write concise, direct README files for experienced engineers.
Principles
- No fluff - Skip tables of contents, verbose explanations, development history
- No roadmaps - Document current state only, not plans or decisions. Readme is an engineering specification. Not a project plan or changelog.
- No repetition - Each fact appears once
- No hype - Avoid "next generation", "production ready", "powerful", "comprehensive" and similar hyperbole
- Direct voice - State facts, not opinions
- No contrasting embellishments - Avoid like "not just a thing, it's a better thing", "not only a thing, it's something", "more than a"
Structure
Sections in order: Overview, Prerequisites, Usage, Architecture, Configuration, Testing, File Structure. One-line purpose statement at top under H1.
Exclude
- Tables of contents
- Verbose troubleshooting guides
- Development decisions/history
- Future plans/roadmaps
- Lengthy explanations of concepts
- Multiple examples of similar things
Formatting
- Tables for structured data (components, variables, test coverage)
- Code blocks for commands and examples
- Bold for emphasis sparingly
- No emojis unless explicitly requested
- No emdashes
Related Skills
jimweller/transcript-search
testing
VerifiedTrustedCommunity
Search saved session transcripts for past decisions, actions, errors, and context that has left the current conversation window.
1SKILL.mdUpdated Apr 22, 2026
jimweller/prd-review
data-ai
VerifiedTrustedCommunity
Review a PRD for defects via Claude opus subagent.
SKILL.mdUpdated Apr 29, 2026
jimweller/md-syntax
development
VerifiedTrustedCommunity
Markdown authoring guidelines for formatting, code blocks, and structure. Use when writing or editing markdown files.
SKILL.mdUpdated Apr 29, 2026
jimweller/fact-check
testing
VerifiedTrustedCommunity
Use when a factual claim lacks evidence, when called out for fabricating facts, or when a statement needs verification before being presented as true. Takes a claim as argument.
SKILL.mdUpdated Apr 29, 2026