readme-craftsman
README Craftsman
Create, update, or review README files by analyzing the actual repository and tailoring output to the project type and audience. Works for any GitHub repository — software projects, documentation sites, datasets, research repos, tutorials, community collections, and more. The goal is to produce READMEs that are accurate, scannable, and genuinely useful — not generic filler.
Workflow
Detect Mode → Analyze Project → Classify Type → [Interview if Creating] → Generate/Update/Review → Quality Check → Deliver
Invocation posture: manual-first
When Not To Use
Do not use this skill for:
- General documentation work that does not specifically target a
README.md
More from liqiongyu/my-skills
brainstorming
Manual-first brainstorming workflow for turning ambiguous ideas or competing directions into an approved decision before planning or implementation. Activate when the user explicitly asks to brainstorm, explore options, compare approaches, or pressure-test a direction. Do not activate for clarification, review, detailed planning, or straightforward execution once a direction is already chosen.
1business-plan
ALWAYS use this skill for ANY business planning, financial analysis, market analysis, pitch deck, strategic review, or valuation task — it contains specialized frameworks, output templates, quality checklists, China/US fundraising guidance, and AI-industry-specific analysis that are NOT available in your base knowledge. Activate whenever the user: writes or updates a business plan; needs financial analysis, P&L review, unit economics, or cash flow modeling; asks about market size (TAM/SAM/SOM) or competitive landscape; creates a pitch deck or investor presentation; requests a SWOT analysis, strategic review, or competitive positioning; needs a valuation estimate; discusses revenue models, pricing strategy, or go-to-market plans; describes a business idea and wants to evaluate feasibility; mentions fundraising, investors, or preparing to raise capital; asks about business model design or wants to structure commercial thinking. This skill is essential even for seemingly straightforward business requests because it provides structured workflows with investor-grade output formats, AI/Agent startup-specific cost modeling and moat frameworks, and China-market fundraising guidance (VIE structures, 赛道叙事, regulatory compliance) that you cannot reliably produce from memory alone. Covers solopreneurs through enterprises, idea stage through mature businesses. When in doubt about whether to use this skill for a business-related request, USE IT.
1