software-design-agent-skill
v1.0.1
Published
Agent skill: a practitioner's checklist distilled from John Ousterhout's A Philosophy of Software Design, for code review and design discussions.
Maintainers
Readme
Software Design Agent Skill
A practical software-design review skill based on the concepts and diagnostic vocabulary in John Ousterhout's A Philosophy of Software Design.
It helps coding agents identify complexity, information leakage, shallow modules, temporal decomposition, vague abstractions, and the other named design red flags. It is intended for code review, architecture discussions, refactoring, and technical writing.
Install
Install with the Skills CLI:
npx skills add lukeramsden/software-design-agent-skill@software-designInstall globally for all supported agents:
npx skills add lukeramsden/software-design-agent-skill@software-design -g -a '*' -yList the skills available in this repository without installing:
npx skills add lukeramsden/software-design-agent-skill --listWhat the skill provides
- Ousterhout's 15 software-design principles
- The 14 canonical red flags, with their canonical names
- Diagnostic vocabulary for complexity and obscurity
- Guidance on deep modules, information hiding, layering, errors, comments, naming, consistency, and performance
- A practical code-review checklist
Repository layout
skills/
└── software-design/
└── SKILL.mdAttribution
This is an independent practitioner's distillation inspired by John Ousterhout's A Philosophy of Software Design (2018). It is not affiliated with or endorsed by John Ousterhout or the book's publisher. Read the original book for the complete argument, examples, and context.
License
The original material in this repository is available under the MIT License. The names and ideas attributed to John Ousterhout remain the work of their respective author and rights holders. See NOTICE.
Install as a pi package
pi install npm:software-design-agent-skillReleasing
npm version patch|minor|major && git push --follow-tagsThe v* tag triggers .github/workflows/publish.yml, which publishes to npm
with OIDC trusted publishing and provenance.
