codebase-documenter

SKILL.md

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 문서를 포함하여 코드베이스에 대한 문서를 작성할 때 사용해야 합니다. 사용자가 코드 문서화, 시작 가이드 작성, 프로젝트 구조 설명 또는 새로운 개발자가 코드베이스에 더 쉽게 액세스할 수 있도록 지원을 요청할 때 이 기술을 사용하십시오. 이 기술은 명확하고 초보자 친화적인 문서를 작성하기 위한 템플릿, 모범 사례 및 구조화된 접근 방식을 제공합니다. 출처: mamba-mental/agent-skill-manager.

원본 보기