codebase-documenter

This skill enables creating comprehensive, beginner-friendly documentation for codebases. It provides structured templates and best practices for writing READMEs, architecture guides, code comments, and API documentation that help new users quickly understand and contribute to projects.

When documenting code for new users, follow these fundamental principles:

When to create: For project root directories, major feature modules, or standalone components.

Этот навык следует использовать при написании документации для баз кода, включая файлы README, документацию по архитектуре, комментарии к коду и документацию по API. Используйте этот навык, когда пользователи запрашивают помощь в документировании своего кода, создании руководств по началу работы, объяснении структуры проекта или повышении доступности кодовых баз для новых разработчиков. Этот навык предоставляет шаблоны, лучшие практики и структурированные подходы для создания понятной, удобной для начинающих документации. Источник: auldsyababua/instructor-workflow.