CtrlK
BlogDocsLog inGet started
Tessl Logo
SkillPublic

source-command-doc-refactor

Restructure project documentation for clarity and accessibility

Quality

70%

Does it follow best practices?

Run evals on this skill

Adds up to 20 points to the overall score

View guide
SecuritybySnyk

Passed

No findings from the security scan

Fix and improve this skill with Tessl

tessl review fix ./.agents/skills/source-command-doc-refactor/SKILL.md
SKILL.md
Quality
Evals
Security

source-command-doc-refactor

Use this skill when the user asks to run the migrated source command doc-refactor.

Command Template

Documentation Refactor

Refactor project documentation structure adapted to project type:

  1. Analyze project: Identify type (library/API/web app/CLI/microservices), architecture, and user personas
  2. Centralize docs: Move technical documentation to docs/ with proper cross-references
  3. Root README.md: Streamline as entry point with overview, quickstart, modules/components summary, license, contacts
  4. Component docs: Add module/package/service-level README files with setup and testing instructions
  5. Organize docs/ by relevant categories:
    • Architecture, API Reference, Database, Design, Troubleshooting, Deployment, Contributing (adapt to project needs)
  6. Create guides (select applicable):
    • User Guide: End-user documentation for applications
    • API Documentation: Endpoints, authentication, examples for APIs
    • Development Guide: Setup, testing, contribution workflow
    • Deployment Guide: Production deployment for services/apps
  7. Use Mermaid for all diagrams (architecture, flows, schemas)

Keep docs concise, scannable, and contextual to project type.

Repository

tonykay/transcriber

Path

.agents/skills/source-command-doc-refactor/SKILL.md

Last updated
First committed

Is this your skill?

If you maintain this skill, you can claim it as your own. Once claimed, you can manage eval scenarios, bundle related skills, attach documentation or rules, and ensure cross-agent compatibility.