Skip to content

Commit e8746ce

Browse files
committed
Updates based on Acrolinx score reports
1 parent 0cd8d2c commit e8746ce

9 files changed

Lines changed: 7 additions & 583 deletions

learn-pr/wwl-azure/spec-driven-development-github-spec-kit-greenfield-intro/10-knowledge-check.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ quiz:
7272
- content: "TDD operates at the unit test level, while SDD works at a higher requirements level to describe complete features."
7373
isCorrect: true
7474
explanation: "Correct. TDD drives design through unit tests for individual functions, while SDD uses specifications that describe complete features to drive design and code generation."
75-
- content: "TDD and SDD are mutually exclusive approaches that cannot be used together."
75+
- content: "TDD and SDD are mutually exclusive approaches that can't be used together."
7676
isCorrect: false
7777
explanation: "Incorrect. TDD and SDD can complement each other. You can use SDD for overall direction and still apply TDD within implementation."
7878
- content: "SDD produces automated tests while TDD produces specifications."
@@ -157,7 +157,7 @@ quiz:
157157
explanation: "Incorrect. Tasks are stored in tasks.md, not constitution.md. The constitution contains guiding principles, not task lists."
158158
- content: "What is the recommended sequence for using GitHub Spec Kit commands in a greenfield project?"
159159
choices:
160-
- content: "Run commands in any order since they are independent of each other."
160+
- content: "Run commands in any order since they're independent of each other."
161161
isCorrect: false
162162
explanation: "Incorrect. The commands follow a specific sequence where each builds on the outputs of the previous one."
163163
- content: "specify init, then /speckit.constitution, /speckit.specify, /speckit.plan, /speckit.tasks, and finally /speckit.implement."

learn-pr/wwl-azure/spec-driven-development-github-spec-kit-greenfield-intro/includes/2-what-spec-driven-development.md

Lines changed: 0 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,3 @@
1-
<!--
2-
=============================================================================
3-
CONTENT SOURCE TRACKING
4-
=============================================================================
5-
This unit was constructed using content from the following sources:
6-
7-
Source File: includes/2-review-spec-driven-development-approach.md
8-
- Section: "The shift to spec-driven development" (paragraphs 1-4)
9-
- Section: "Why spec-driven development matters now" (all bullet points)
10-
- Section: "The core principles of spec-driven development" (adapted for key features)
11-
- Opening paragraph (traditional development context)
12-
13-
Source File: includes/3-examine-github-spec-kit.md
14-
- Opening paragraph (context about AI-assisted development challenges)
15-
=============================================================================
16-
-->
17-
181
In traditional software development, we often treat code as the ultimate source of truth. Specifications serve code - they're the scaffolding we build and then discard once the "real work" of coding begins. We write Product Requirements Documents (PRDs) to guide development, create design docs to inform implementation, and draw diagrams to visualize architecture. But these documents are always subordinate to the code itself. As code moves forward, specs rarely keep pace.
192

203
With the rise of powerful AI coding assistants like GitHub Copilot, this code-first approach evolved into what we now call "vibe coding." Unfortunately, the vibe coding approach often involves submitting a high-level prompt that returns a chunk of code that "looks right" but might miss the intent or have errors. It can be fast, but sometimes it's misaligned. Each chat session operates in isolation, lacking awareness of previous decisions or overall project requirements.

learn-pr/wwl-azure/spec-driven-development-github-spec-kit-greenfield-intro/includes/3-examine-spec-driven-development-principles-processes.md

Lines changed: 0 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,3 @@
1-
<!--
2-
## Content Sources
3-
4-
This unit was built from the following source content:
5-
6-
**Primary Sources:**
7-
- includes/2-review-spec-driven-development-approach.md
8-
- "The shift to spec-driven development" section
9-
- "The spec-driven development workflow in practice" section
10-
- "The core principles of spec-driven development" section
11-
- "Why spec-driven development matters now" section
12-
13-
**Supporting Sources:**
14-
- includes/5-write-effective-spec-file.md
15-
- "The spec as the single source of truth" section (Specify phase details)
16-
- includes/6-create-technical-plan-file.md
17-
- "Understand the purpose of a technical plan" section (Plan phase details)
18-
- includes/7-generate-implementation-tasks-file.md
19-
- "Benefits of task breakdown" section (Tasks phase details)
20-
- "Phase-based organization" section
21-
-->
22-
231
The spec-driven development (SDD) methodology provides a phased approach to software development that emphasizes clarity, structure, and adaptability. By breaking down the development process into four distinct phases—Specify, Plan, Tasks, and Implement—SDD ensures that each step is well-defined and builds upon the previous one. This structured workflow not only enhances communication among stakeholders but also allows for continuous refinement and adaptation of the software being developed.
242

253
## SDD workflow overview

learn-pr/wwl-azure/spec-driven-development-github-spec-kit-greenfield-intro/includes/4-compare-spec-driven-development-other-methodologies.md

Lines changed: 0 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,3 @@
1-
<!--
2-
## Content Sources
3-
4-
This unit was built from the following source content:
5-
6-
**Primary Sources:**
7-
- includes/2-review-spec-driven-development-approach.md
8-
- "The shift to spec-driven development" section (SDD core characteristics)
9-
- "Why spec-driven development matters now" section (drivers and benefits)
10-
- "The core principles of spec-driven development" section
11-
12-
**Supporting Sources:**
13-
- includes/5-write-effective-spec-file.md
14-
- "For enterprise developers accustomed to agile workflows..." (Agile comparison context)
15-
- includes/7-generate-implementation-tasks-file.md
16-
- Task granularity and verification concepts (for TDD comparison)
17-
- Module Outline
18-
- Unit 4 outline requirements (comparison framework and methodology positioning)
19-
20-
**Note:** The source module doesn't contain direct methodology comparisons. Content was derived from SDD principles in source materials and structured according to the module outline's comparison framework.
21-
-->
22-
231
Understanding how spec-driven development (SDD) relates to other software development methodologies helps you see where it fits in your existing practices. Rather than replacing what you already know, SDD can complement and enhance established approaches, especially when you're using AI-assisted development tools.
242

253
## Methodology comparison overview

learn-pr/wwl-azure/spec-driven-development-github-spec-kit-greenfield-intro/includes/5-examine-spec-driven-development-workflow-phases.md

Lines changed: 0 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,3 @@
1-
<!--
2-
## Content Sources
3-
4-
This unit was built from the following source content:
5-
6-
**Primary Sources:**
7-
- includes/5-write-effective-spec-file.md
8-
- "The spec as the single source of truth" section
9-
- "Specification structure" section (Summary, User Stories, Acceptance Criteria, Functional Requirements, Nonfunctional Requirements, Edge Cases)
10-
11-
- includes/6-create-technical-plan-file.md
12-
- "Understand the purpose of a technical plan" section
13-
- "Examine plan structure and content" section (Architecture overview, Technology stack, Implementation sequence, Constitution verification, Assumptions)
14-
15-
- includes/7-generate-implementation-tasks-file.md
16-
- "Benefits of task breakdown" section
17-
- "Examine task structure and organization" section (Phase-based organization, Task granularity, Dependencies)
18-
19-
**Supporting Sources:**
20-
- includes/2-review-spec-driven-development-approach.md
21-
- "The spec-driven development workflow in practice" section (workflow flow narrative)
22-
-->
23-
241
Each phase of the Spec-Driven Development (SDD) workflow plays a crucial role in transforming ideas into working software. Developers who understand the purpose, content, and output of each phase can apply SDD effectively to their own projects.
252

263
> [!NOTE]

learn-pr/wwl-azure/spec-driven-development-github-spec-kit-greenfield-intro/includes/6-introduction-github-spec-kit.md

Lines changed: 0 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,3 @@
1-
<!--
2-
## Content Sources
3-
4-
This unit was built from the following source content:
5-
6-
**Primary Sources:**
7-
- includes/3-examine-github-spec-kit.md
8-
- "What is GitHub Spec Kit?" section
9-
- "Key components of GitHub Spec Kit" section (Specify CLI, Markdown artifact files, Slash commands)
10-
- "GitHub Spec Kit's AI agent support" section (Multi-agent compatibility)
11-
- "Integrate GitHub Spec Kit with Git workflows" section (Project structure conventions)
12-
13-
**Supporting Sources:**
14-
- includes/4-establish-project-principles-constitution-file.md
15-
- Constitution concept and purpose (for explaining project constitution)
16-
-->
17-
181
GitHub Spec Kit is an open-source toolkit that operationalizes spec-driven development (SDD) by providing a structured workflow, persistent artifacts, and AI integration. It guides you through the SDD phases of Specify, Plan, Tasks, and Implement using commands and templates, enabling efficient, consistent, and high-quality software development.
192

203
## What is GitHub Spec Kit?

learn-pr/wwl-azure/spec-driven-development-github-spec-kit-greenfield-intro/includes/7-examine-github-spec-kit-environment-installation.md

Lines changed: 5 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,3 @@
1-
<!--
2-
## Content Sources
3-
4-
This unit was built from the following source content:
5-
6-
**Primary Sources:**
7-
- includes/3-examine-github-spec-kit.md
8-
- "Key components of GitHub Spec Kit" → "Specify CLI tool" section (installation commands)
9-
- "GitHub Spec Kit's AI agent support" → "Multi-agent compatibility" section (supported agents list)
10-
11-
**Supporting Sources:**
12-
- Module Outline (Unit 7)
13-
- Prerequisites and system requirements
14-
- Installation methods (global and one-time)
15-
- Visual Studio Code setup specifics
16-
- Troubleshooting guidance
17-
18-
**External References:**
19-
- GitHub Spec Kit README (installation instructions, uv tool usage)
20-
- blog.ovilgroup.com (installation walkthrough, prerequisites)
21-
-->
22-
231
Before you can use GitHub Spec Kit to practice spec-driven development, you need to set up your environment. This unit covers the prerequisites, installation process, and configuration steps to get GitHub Spec Kit running in your development environment.
242

253
## Prerequisites and system requirements
@@ -89,9 +67,9 @@ uv tool install specify-cli --from git+https://github.com/github/spec-kit.git
8967

9068
Global installation provides these benefits:
9169

92-
- Available in any project directory
93-
- Easy to update using `uv tool upgrade specify-cli`
94-
- No need to rerun installation commands each time
70+
- Available in any project directory.
71+
- Easy to update using `uv tool upgrade specify-cli`.
72+
- No need to rerun installation commands each time.
9573

9674
### Method 2: One-time usage
9775

@@ -118,8 +96,8 @@ specify check
11896

11997
This command checks for required tools and confirms that installation succeeded. It reports:
12098

121-
- Whether Git is found and configured.
122-
- Whether your AI coding assistant is detected.
99+
- Whether or not Git is found and configured.
100+
- Whether or not your AI coding assistant is detected.
123101
- Any missing dependencies or configuration issues.
124102

125103
If `specify check` reports issues, address them before proceeding.

learn-pr/wwl-azure/spec-driven-development-github-spec-kit-greenfield-intro/includes/8-examine-github-spec-kit-commands-results.md

Lines changed: 0 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,3 @@
1-
<!--
2-
## Content Sources
3-
4-
This unit was built from the following source content:
5-
6-
**Primary Sources:**
7-
- includes/3-examine-github-spec-kit.md
8-
- "Key components of GitHub Spec Kit" → "Slash commands" section
9-
- "Leverage GitHub Spec Kit's optional enhancement commands" section (/speckit.clarify, /speckit.analyze, /speckit.checklist)
10-
- "Continuous workflow support" section (command chaining)
11-
12-
**Supporting Sources:**
13-
- includes/4-establish-project-principles-constitution-file.md
14-
- Constitution purpose and structure (for /speckit.constitution context)
15-
- includes/5-write-effective-spec-file.md
16-
- Spec structure and sections (for spec.md output context)
17-
- includes/6-create-technical-plan-file.md
18-
- Plan structure and content (for plan.md output context)
19-
- includes/7-generate-implementation-tasks-file.md
20-
- Task structure and organization (for tasks.md output context)
21-
-->
22-
231
With GitHub Spec Kit installed, you're ready to use its commands to practice spec-driven development. This unit walks through each command in the workflow, explaining what it does, what output it produces, and how to work with the results. Understanding this process prepares you for the hands-on lab exercise.
242

253
## Command overview

0 commit comments

Comments
 (0)