Skip to main content

Global Commenting

Write self-documenting code with clear structure and naming, adding minimal, helpful, evergreen comments only for large sections of complex logic, avoiding comments about recent changes or temporary fixes. Use this skill when writing or reviewing code in any file where comments or code documentation are involved. Apply when deciding whether to add comments, when refactoring code to be more self-explanatory through better naming and structure, when reviewing existing comments for relevance and evergreen quality, when removing outdated or change-related comments, or when adding concise explanatory comments for complex logic sections. Use for any task involving code documentation strategy, comment quality assessment, or improving code readability through structure rather than comments.

星标

7

分支

0

更新时间

2025年10月29日 14:48

下载技能文件

下载包含 SKILL.md 和所有相关文件的完整技能目录

相关技能

maxritter

Global Conventions

maxritter

Follow consistent project structure, clear documentation, version control best practices, environment configuration, dependency management, code review processes, and feature flag usage for maintainable team development. Use this skill when organizing project files and directories, writing or updating documentation (README files, architecture docs, contribution guidelines), managing dependencies (package.json, requirements.txt, Gemfile), configuring environment variables, implementing feature flags, writing commit messages, creating pull/merge requests, or establishing team development workflows. Apply when setting up project structure, documenting setup instructions, managing configuration files, maintaining changelogs, or implementing development conventions. Use for any task involving project organization, team collaboration standards, or development workflow best practices.

7documents-content
Toowiredd

repository-analyzer

Toowiredd

Analyzes codebases to generate comprehensive documentation including structure, languages, frameworks, dependencies, design patterns, and technical debt. Use when user says "analyze repository", "understand codebase", "document project", or when exploring unfamiliar code.

11documents-content
wordflowlab

scene-structure-techniques

wordflowlab

Use when structuring scenes or planning chapter content - provides scene-sequel framework, tension management, and beat-by-beat structure for compelling scenes

9documents-content
wordflowlab

natural-dialogue-techniques

wordflowlab

Use when writing dialogue scenes or when user asks about character conversations - provides techniques for natural, character-consistent dialogue that reveals character and advances plot

9documents-content
wordflowlab

pre-write-checklist

wordflowlab

Activates automatically before chapter writing to enforce the 9-item mandatory file reading checklist - prevents AI focus degradation in long-form fiction by ensuring all context is loaded before each writing session

9documents-content
wordflowlab

story-consistency-monitor

wordflowlab

Use during chapter writing to automatically check character behavior, world rules, and timeline consistency - alerts when detecting potential contradictions before they become major issues

9documents-content
wordflowlab

mystery-novel-conventions

wordflowlab

Use when user mentions mystery, detective, crime, or suspense-focused narrative - provides genre conventions, clue placement, and fair play principles for mystery writing

9documents-content
CuriousLearner

architecture-documenter

CuriousLearner

Document system architecture and technical design decisions for effective team communication and ...

9documents-content
CuriousLearner

onboarding-helper

CuriousLearner

Generate comprehensive onboarding documentation and guides for new developers joining your team o...

9documents-content
CuriousLearner

documentation-generator

CuriousLearner

Auto-generate JSDoc, docstrings, README files, and API documentation.

9documents-content
CuriousLearner

api-documentation

CuriousLearner

Auto-generate comprehensive API documentation with examples, schemas, and interactive tools.

9documents-content
CuriousLearner

env-manager

CuriousLearner

Environment variable management, validation, and documentation.

9documents-content
Global Commenting - maxritter 的 Claude AI 技能 | SkillsMP