Skills
.Work. You
Rest

Code Commentary

Community

Document code for human understanding.

Software Engineering#documentation#collaboration#maintainability#code comments#developer tooling#plain english
AuthorGambitnl
Version1.0.0
Installs0

System Documentation

What problem does it solve?

This Skill ensures that all code is accompanied by clear, plain-English comments, making it understandable for the project owner and future developers who do not read code.

Core Features & Use Cases

  • Universal Commenting Standard: Enforces consistent commenting practices across all code files.
  • Three Layers of Commentary: Guides developers on commenting at the file, section, and block levels.
  • Debt and Shortcut Flagging: Provides clear methods (// DEBT:, // HACK:, // TODO(next-agent):) to mark areas needing future attention.
  • Preservationist Rules: Outlines principles for making changes with minimal impact and maintaining structural integrity.
  • Red Flags Checklist: Helps identify and rectify common anti-patterns like excessive any types or console.log statements.
  • Use Case: When writing a new feature, use this skill to ensure every part of the new code is explained, making it easy for the project owner to review and understand without needing to dive into the code logic itself.

Quick Start

Apply the code commentary skill to document the newly written TypeScript file located at '/src/utils/helpers.ts'.

Dependency Matrix

Required Modules

None required

Components

Standard package

💻 Claude Code Installation

Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.

Please help me install this Skill:
Name: Code Commentary
Download link: https://github.com/Gambitnl/Aralia/archive/main.zip#code-commentary

Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
View Source Repository

Agent Skills Search Helper

Install a tiny helper to your Agent, search and equip skill from 223,000+ vetted skills library on demand.