hermeticormus/plugins/developer-guides/skills/developer-guide-patterns
plugins/developer-guides/skills/developer-guide-patterns/SKILL.md
# Developer Guide Patterns > Patterns for writing developer onboarding documentation, contributing guides, and integration docs. ## Knowledge Base ### The Developer Journey Developers interact with a project through distinct phases, each needing different documentation: ``` Discover --> Evaluate --> Adopt --> Build --> Contribute --> Maintain | | | | | | README Quick Start Install Guides CONTRIBUTING Architecture + Exa
tools
Updated Apr 21, 2026
$ install --global
skillsauthnpx skillsauth add hermeticormus/librecopy-claude-code plugins/developer-guides/skills/developer-guide-patternsInstall 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 21, 2026, 10:02 PM175.4s1 file scanned
SKILL.md
Developer Guide Patterns
Patterns for writing developer onboarding documentation, contributing guides, and integration docs.
Knowledge Base
The Developer Journey
Developers interact with a project through distinct phases, each needing different documentation:
Discover --> Evaluate --> Adopt --> Build --> Contribute --> Maintain
| | | | | |
README Quick Start Install Guides CONTRIBUTING Architecture
+ Examples + Setup + API + PRs + ADRs
Getting Started: The 15-Minute Rule
A new developer should go from git clone to running tests in 15 minutes or less. Every minute beyond that is a barrier to contribution.
Measure your setup time:
- Start a timer when running
git clone - Follow your own getting-started guide exactly
- Stop when tests pass
- If over 15 minutes, automate or simplify
The Prerequisites Table
Never use prose for prerequisites. Use a table:
| Tool | Minimum Version | Check Command | Install Link |
|------|----------------|---------------|-------------|
| Node.js | 20.0.0 | node --version | nodejs.org |
| Docker | 24.0.0 | docker --version | docker.com |
| PostgreSQL | 16.0 | psql --version | Via Docker or native |
Contributing Guide Structure
Standard sections in order of importance:
- Code of Conduct - Link to or embed the Contributor Covenant
- Quick Contribution Guide - For typo fixes and small changes (minimal process)
- Development Setup - How to get the project running for development
- How to Submit Changes - Branch naming, commit format, PR process
- Code Standards - Linting rules, formatting, naming conventions
- Testing Requirements - What tests are expected with different types of changes
- Review Process - What to expect after opening a PR, SLA for reviews
- Release Process - How changes get from merged PR to released version
- Getting Help - Where to ask questions (Discord, discussions, issues)
Integration Documentation Structure
- Overview - What the integration does, architectural diagram
- Prerequisites - Accounts, credentials, access requirements
- Authentication - How to authenticate (API key, OAuth, etc.)
- Core Setup - Install SDK, configure client, first API call
- Common Operations - CRUD operations with code examples
- Webhooks - Receiving events, signature verification, payload schemas
- Error Handling - Error codes, retry strategies, fallback behavior
- Testing - Sandbox environments, mock servers, test credentials
- Troubleshooting - Common issues and their solutions
- Migration - Upgrading from previous versions
Patterns
- Script Aliases: Document
Makefileorpackage.jsonscript aliases so developers runmake testnotdocker compose exec app pytest --cov --tb=short -q. - Environment Variables Table: List every env var with its purpose, required/optional status, and example value. Never just say "copy .env.example".
- Architecture Before Code: In contributing guides, include a brief architecture overview so contributors understand where their change fits.
- Issue Labels as Onboarding: Document issue label meanings.
good first issue,help wanted,bug,enhancementshould be explained. - Review Checklist: Provide a PR checklist that contributors can self-review against before requesting review.
Anti-Patterns
- "It's in the code": Telling contributors to read the source code instead of documenting architecture. Code shows what, docs explain why.
- Implicit prerequisites: Assuming everyone has Docker, Go, and PostgreSQL installed. List everything.
- Stale scripts: Documenting
npm run testwhen the actual command ispnpm test. Keep docs in sync with package.json. - No first-issue path: Contributing docs that only describe the process for major features. Include guidance for small first contributions.
- Setup scripts without explanation: A
setup.shthat does 20 things silently. Developers need to understand what setup does so they can debug when it fails.
References
- GitHub's Guide to CONTRIBUTING.md
- Contributor Covenant
- First Timers Only
- Diataxis - How-to Guides
Related Skills
hermeticormus/plugins/user-documentation/skills/user-doc-patterns
tools
VerifiedTrustedCommunity
# User Doc Patterns > Patterns for writing clear, accessible end-user documentation. ## Knowledge Base ### User Documentation vs Developer Documentation | User Docs | Developer Docs | |-----------|---------------| | Task-oriented ("How do I...") | Concept-oriented ("How does it work...") | | Plain language | Technical language | | Screenshots and visual aids | Code examples | | Step-by-step procedures | API references | | Feature names and UI labels | Function signatures and parameters | | A
SKILL.mdUpdated Apr 21, 2026
hermeticormus/plugins/tutorial-creation/skills/tutorial-structures
tools
VerifiedTrustedCommunity
# Tutorial Structures > Pedagogical patterns and frameworks for creating effective technical tutorials. ## Knowledge Base ### The Tutorial Spectrum Tutorials exist on a spectrum between two extremes: | Recipe | Concept Guide | |--------|--------------| | "Do exactly this" | "Understand this idea" | | Step-by-step | Explanation-heavy | | Fast to complete | Deep understanding | | Low retention | High retention | The best tutorials blend both: steps for doing, explanations for understanding.
SKILL.mdUpdated Apr 21, 2026
hermeticormus/plugins/tutorial-creation/skills/tutorial-patterns
tools
VerifiedTrustedCommunity
# Tutorial Patterns ## Tutorial vs. How-to Guide: The Critical Distinction Before writing, identify which document is actually needed: | Tutorial | How-to Guide | |----------|-------------| | "Build a REST API in Node.js" | "Add JWT authentication to your Express API" | | For someone new to this | For someone who knows the domain | | Explains why each step is done | Steps are efficient, minimal explanation | | Has checkpoints, explores | Numbered steps, no detours | | Learner reaches a comple
SKILL.mdUpdated Apr 21, 2026
hermeticormus/plugins/technical-blogging/skills/tech-blogging-patterns
tools
VerifiedTrustedCommunity
# Tech Blogging Patterns ## The Developer Reading Pattern Developers do not read technical posts linearly. They scan in this order: 1. Headline (is this relevant to me?) 2. Code blocks (is this real code I can use?) 3. Headers (what does this cover?) 4. First paragraph (what's the point?) 5. Key takeaways / conclusion (is it worth reading fully?) Design for scanning first, reading second. Put real code within the first 25% of the post. ## The Before/After Pattern The contrast between a pain
SKILL.mdUpdated Apr 21, 2026