Readme Writer
- 1 installs
- Updated June 12, 2026
- ahsan361/crisis-intelligence-response-orchestrator
readme-writer is a Claude Code skill that writes technical README documentation grounded in a project's real source files, using badges and diagrams.
About
readme-writer produces technical README documentation based explicitly on a project's real files rather than invented concepts. It uses Markdown badges and ASCII or Mermaid diagrams to break down architecture, keeps the root README concise, and never includes raw API keys. It cross-references the project's models file to verify that documented data schemas and fields stay current. The skill is tailored to the CIRO project and a hackathon-judge audience.
- Writes technical README docs grounded in the real CIRO project files
- Uses Markdown badges and Mermaid/ASCII diagrams for architecture
- Cross-references models to keep documented schemas current
Readme Writer by the numbers
- 1 all-time installs (skills.sh)
- Ranked #1,366 of 1,879 Documentation skills by installs in the Skillselion catalog
- Data as of Jul 7, 2026 (Skillselion catalog sync)
readme-writer capabilities & compatibility
- Capabilities
- readme writing · documentation · architecture diagramming
- Use cases
- documentation
- Pricing
- Free
What readme-writer says it does
Write comprehensive technical documentation.
Base all documentation explicitly on the real CIRO project files (e.g., `main.py`, `PROJECT_SPEC.md`, Flutter `lib/`). Do not invent generic architectural concepts.
Never include raw API keys in README examples or setup blocks.
npx skills add https://github.com/ahsan361/crisis-intelligence-response-orchestrator --skill readme-writerAdd your badge
Show developers this skill is listed on Skillselion. Paste this into your README.
| Installs | 1 |
|---|---|
| Last updated | June 12, 2026 |
| Repository | ahsan361/crisis-intelligence-response-orchestrator ↗ |
What it does
Write a concise, accurate technical README grounded in the project's real source files and current schemas.
Who is it for?
Documenting the CIRO project for a technical, hackathon-judge audience.
Skip if: Including raw API keys in setup blocks, which the docs prohibit.
When should I use this skill?
You need a technical README that accurately reflects the project's real files, architecture, and current data schemas.
What you get
A concise, accurate README with badges and diagrams cross-referenced against the project's real files and models.
- a concise technical README with badges and architecture diagrams
By the numbers
- root README capped at max 2 printed pages
Files
README Writer Skill
Instructions
1. Accuracy: Base all documentation explicitly on the real CIRO project files (e.g., main.py, PROJECT_SPEC.md, Flutter lib/). Do not invent generic architectural concepts. 2. Visuals: Utilize Markdown badges (for FastAPI, Supabase, Flutter, Gemini) and ASCII/Mermaid diagrams to visually break down architecture. 3. Tone: The tone should be technical, professional, and targeted toward hackathon judges. Emphasize "AI transparency", "Mechanism 4", and "multi-source ingestion".
Constraints
- Never include raw API keys in README examples or setup blocks.
- Keep the root
README.mdconcise—max 2 printed pages.
Common Pitfalls
- Outdated Schemas: Documenting old data models. Always cross-reference
backend/models.pyto verify the current fields (e.g., ensuringcrisis_confidenceanddetected_languageare mentioned).
Related skills
Lark MarkdownInstantly turn any markdown file into clean, formatted Lark/Figma-compatible documents without manual reformatting.488k
Lark DocCreate, read, update, summarize, rewrite and manage Feishu/Lark cloud documents directly from agent workflows.401k16.1kLark WikiCreate, organize, query, and manage documents, spaces, and members inside Lark (Feishu) knowledge bases directly from AI agent workflows.397k16.1k
Domain ModelingBuild and sharpen a project's domain model: pin down domain terminology in a glossary and record architectural decisions as ADRs.318k202k
Opensource Guide CoachGet expert, attribution-safe guidance on launching and sustaining an open-source project.270k71Readme I18nMaintain consistent, updatable language selector blocks across every README variant in a multilingual repository.270k71FAQ
Does it invent architecture details?
No. It bases all documentation explicitly on the real project files and does not invent generic architectural concepts.
How does it keep schemas current?
It cross-references the project's models file to verify current fields like crisis_confidence and detected_language are documented.