Skip to content

stevenacoffman/software-design

v0.1.0MIT

Software design and refactoring: deep modules, information hiding, and incremental change.

write-comments-first-as-design-tool

Use when starting a new class, interface, or public method: write the interface comment before the implementation as a design check. Also when a module can't be understood from its interface comments, after a refactor changes semantics, or when a long comment hints at complexity.

Read SKILL.md at the source

Pinned to revision e4081cbb4d29, so it is the text this page describes rather than whatever the author pushed since.

Files

Every link opens the file at its source, pinned to the revision this page describes.