writing-project-readme
OfficialRewrite comprehensive READMEs for projects.
Content & Communication#architecture#templates#documentation#communication#readme#project-management#writing-guide
Authordouinc
Version1.0.0
Installs0
System Documentation
What problem does it solve?
This skill generates a single, readable README that documents tech stack, architecture, features, and service description for both non-engineers (PM, design, ops) and developers. It is intended for full rewrites triggered by explicit demand, not ad-hoc edits.
Core Features & Use Cases
- Comprehensive README generation: captures architecture, tech stack, features, and service scope in one document.
- Audience-aware writing: crafted for cross-functional teams including non-engineers and engineers.
- Explicit invocation guardrails: runs only on explicit requests, avoids automatic rewrites, and links to development docs.
Quick Start
Explicitly invoke the skill with a clear request such as "write the README" or "/writing-project-readme" to trigger a full rewrite.
Dependency Matrix
Required Modules
None requiredComponents
Standard package💻 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: writing-project-readme Download link: https://github.com/douinc/agent-skills/archive/main.zip#writing-project-readme 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 510,000+ vetted skills library on demand.