docs-that-work
OfficialWrite documentation that works for humans and AI.
Authorprovectus
Version1.0.0
Installs0
System Documentation
What problem does it solve?
This Skill addresses the challenge of creating documentation that is both understandable to human readers and easily processable by AI agents, ensuring clarity and discoverability.
Core Features & Use Cases
- Discoverability Rule Enforcement: Guides users to document only what cannot be inferred from code.
- Structured Documentation: Provides clear guidelines for
CLAUDE.mdandREADME.mdto maximize utility and minimize bloat. - Use Case: When tasked with creating documentation for a new project, use this Skill to ensure the
README.mdis actionable for onboarding andCLAUDE.mdprovides essential, non-discoverable context for AI agents.
Quick Start
Use the docs-that-work skill to generate a CLAUDE.md file for a new Python project.
Dependency Matrix
Required Modules
None requiredComponents
references
💻 Claude Code Installation
Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.
Please help me install this Skill: Name: docs-that-work Download link: https://github.com/provectus/awos-recruitment/archive/main.zip#docs-that-work Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
Agent Skills Search Helper
Install a tiny helper to your Agent, search and equip skill from 471,000+ vetted skills library on demand.