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.

Diese Fähigkeit sollte beim Schreiben von Dokumentation für Codebasen verwendet werden, einschließlich README-Dateien, Architekturdokumentation, Codekommentaren und API-Dokumentation. Nutzen Sie diese Fähigkeit, wenn Benutzer Hilfe bei der Dokumentation ihres Codes, bei der Erstellung von Leitfäden für den ersten Schritt, bei der Erläuterung der Projektstruktur oder bei der Verbesserung des Zugangs zu Codebasen für neue Entwickler anfordern. Der Skill bietet Vorlagen, Best Practices und strukturierte Ansätze für die Erstellung einer klaren, einsteigerfreundlichen Dokumentation. Quelle: auldsyababua/instructor-workflow.