software-engineering-discipline

Enforce verification plans and frozen interfaces before coding tasks.

Updated Feb 5, 2021
One-click install
npx skills add https://github.com/liqiha0/dotfiles --skill software-engineering-discipline
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: software-engineering-discipline
Source: https://github.com/liqiha0/dotfiles/tree/main/dot_config/opencode/skills/software-engineering-discipline
Command: npx skills add https://github.com/liqiha0/dotfiles --skill software-engineering-discipline

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill ensures that software engineering tasks begin from a disciplined, knowledge-driven workflow, reducing defects by enforcing zero-ambiguity scans, design verification, protocol checks, and systematic knowledge capture.

Core Features & Use Cases

  • Zero Ambiguity Scan: Retrieve context from project notes and issue trackers, scan code for existing patterns, and align terminology.
  • Design Verification & Protocol Check: Define validation methods before coding and freeze public interfaces when necessary to prevent scope drift.
  • Knowledge Loop: Document major decisions and hidden logic to Obsidian for future reference and governance.
  • Use Case: In a bug-fix or refactor, begin with a clear verification plan and stable interfaces to ensure safe changes.

Quick Start

Follow the mandated discipline steps before starting any implementation or debugging work.

Frequently Asked Questions about software-engineering-discipline

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I enforce design verification before starting a coding task?

Design verification is enforced by defining explicit validation methods and freezing public interfaces before implementation. This prevents scope drift and ensures software changes are observable and reversible.

What is a zero ambiguity scan and when do I need it for refactoring?

A zero ambiguity scan retrieves context from issue trackers, scans code for existing patterns, and aligns terminology. It is needed before refactoring to reduce defects by establishing a knowledge-driven workflow.

How do I freeze public interfaces to prevent API scope drift?

Freezing public interfaces involves executing protocol checks to lock down domain interfaces before coding. This mandated discipline step prevents scope drift and ensures stable API boundaries during implementation.

What's the best way to document hidden logic and major design decisions?

The best way to document hidden logic is through a knowledge loop that captures major decisions into Obsidian. This ensures future reference and governance by systematically recording hidden logic.

Does this software engineering discipline workflow work for database changes?

Yes, this software engineering discipline workflow applies to database changes. It guides required steps and artifacts, requiring explicit verification plans and frozen interfaces to ensure safe modifications.

Why do I need an explicit verification plan for debugging tasks?

An explicit verification plan is required for debugging tasks to ensure changes are observable and reversible. It enforces systematic knowledge capture and protocol checks, reducing defects during bug fixes.