Skip to content

Commit de4f7a9

Browse files
📖[Docs]: Improve README clarity and formatting (#192)
This release comprehensively improves documentation quality across the entire repository by fixing 21 instances of typos, grammatical errors, and formatting inconsistencies in 9 files. All changes enhance readability, professionalism, and clarity without any breaking changes or functionality modifications. ## Why These Changes Matter Documentation is the first point of contact for users and contributors. Unclear language, typos, and inconsistent formatting create friction and reduce confidence in the project. Poor documentation quality can lead to misunderstandings, incorrect implementations, and increased support burden. These improvements make the documentation more professional, scannable, and easier to understand for both new users and experienced contributors. ## How the Documentation Was Improved The improvements span three main categories: **Grammar & Language Clarity:** Fixed verb tense inconsistencies ("trigger" → "triggered"), corrected countable vs uncountable noun usage ("less" → "fewer"), added Oxford commas for better readability, improved sentence structure, and added missing articles throughout. **Formatting Standardization:** Standardized file references using inline code formatting (`` `BeforeAll.ps1` ``), converted mathematical notation to proper Unicode symbols (≤ instead of <=), improved list structures with consistent nested bullets, and enhanced visual hierarchy in workflow documentation. **Content Restructuring:** Reorganized test setup/teardown documentation for better flow, moved key information to prominent positions, eliminated redundant sections, integrated scattered information into main descriptions, and created clearer section divisions. --------- Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
1 parent 7e38e21 commit de4f7a9

File tree

9 files changed

+73
-81
lines changed

9 files changed

+73
-81
lines changed

.github/prompts/analyze.prompt.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -61,9 +61,9 @@ Execution steps:
6161

6262
5. Severity assignment heuristic:
6363
- CRITICAL: Violates constitution MUST, missing core spec artifact, or requirement with zero coverage that blocks baseline functionality.
64-
- HIGH: Duplicate or conflicting requirement, ambiguous security/performance attribute, untestable acceptance criterion.
65-
- MEDIUM: Terminology drift, missing non-functional task coverage, underspecified edge case.
66-
- LOW: Style/wording improvements, minor redundancy not affecting execution order.
64+
- HIGH: Duplicate or conflicting requirement, ambiguous security/performance attribute, or untestable acceptance criterion.
65+
- MEDIUM: Terminology drift, missing non-functional task coverage, or underspecified edge case.
66+
- LOW: Style/wording improvements, or minor redundancy not affecting execution order.
6767

6868
6. Produce a Markdown report (no file writes) with sections:
6969

@@ -95,9 +95,9 @@ Execution steps:
9595
* Critical Issues Count
9696

9797
7. At end of report, output a concise Next Actions block:
98-
- If CRITICAL issues exist: Recommend resolving before `/implement`.
99-
- If only LOW/MEDIUM: User may proceed, but provide improvement suggestions.
100-
- Provide explicit command suggestions: e.g., "Run /specify with refinement", "Run /plan to adjust architecture", "Manually edit tasks.md to add coverage for 'performance-metrics'".
98+
- If CRITICAL issues exist: Recommend resolving them before `/implement`.
99+
- If only LOW/MEDIUM issues: User may proceed, but provide improvement suggestions.
100+
- Provide explicit command suggestions: e.g., "Run /specify with refinement", "Run /plan to adjust architecture", or "Manually edit tasks.md to add coverage for 'performance-metrics'".
101101

102102
8. Ask the user: "Would you like me to suggest concrete remediation edits for the top N issues?" (Do NOT apply them automatically.)
103103

.github/prompts/clarify.prompt.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -79,10 +79,10 @@ Execution steps:
7979
- Information is better deferred to planning phase (note internally)
8080

8181
3. Generate (internally) a prioritized queue of candidate clarification questions (maximum 5). Do NOT output them all at once. Apply these constraints:
82-
- Maximum of 5 total questions across the whole session.
82+
- Maximum of 5 total questions across the entire session.
8383
- Each question must be answerable with EITHER:
8484
* A short multiple‑choice selection (2–5 distinct, mutually exclusive options), OR
85-
* A one-word / short‑phrase answer (explicitly constrain: "Answer in <=5 words").
85+
* A one-word / short‑phrase answer (explicitly constrain: "Answer in 5 words").
8686
- Only include questions whose answers materially impact architecture, data modeling, task decomposition, test design, UX behavior, operational readiness, or compliance validation.
8787
- Ensure category coverage balance: attempt to cover the highest impact unresolved categories first; avoid asking two low-impact questions when a single high-impact area (e.g., security posture) is unresolved.
8888
- Exclude questions already answered, trivial stylistic preferences, or plan-level execution details (unless blocking correctness).
@@ -102,9 +102,9 @@ Execution steps:
102102
| Short | Provide a different short answer (<=5 words) (Include only if free-form alternative is appropriate) |
103103
```
104104

105-
- For short‑answer style (no meaningful discrete options), output a single line after the question: `Format: Short answer (<=5 words)`.
105+
- For short‑answer style (no meaningful discrete options), output a single line after the question: `Format: Short answer (5 words)`.
106106
- After the user answers:
107-
* Validate the answer maps to one option or fits the <=5 word constraint.
107+
* Validate the answer maps to one option or fits the 5 word constraint.
108108
* If ambiguous, ask for a quick disambiguation (count still belongs to same question; do not advance).
109109
* Once satisfactory, record it in working memory (do not yet write to disk) and move to the next queued question.
110110
- Stop asking further questions when:

.github/prompts/constitution.prompt.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Follow this execution flow:
1616

1717
1. Load the existing constitution template at `.specify/memory/constitution.md`.
1818
- Identify every placeholder token of the form `[ALL_CAPS_IDENTIFIER]`.
19-
**IMPORTANT**: The user might require less or more principles than the ones used in the template. If a number is specified, respect that - follow the general template. You will update the doc accordingly.
19+
**IMPORTANT**: The user might require fewer or more principles than the ones used in the template. If a number is specified, respect that - follow the general template. You will update the document accordingly.
2020

2121
2. Collect/derive values for placeholders:
2222
- If user input (conversation) supplies a value, use it.
@@ -52,7 +52,7 @@ Follow this execution flow:
5252
6. Validation before final output:
5353
- No remaining unexplained bracket tokens.
5454
- Version line matches report.
55-
- Dates ISO format YYYY-MM-DD.
55+
- Dates in ISO format (YYYY-MM-DD).
5656
- Principles are declarative, testable, and free of vague language ("should" → replace with MUST/SHOULD rationale where appropriate).
5757

5858
7. Write the completed constitution back to `.specify/memory/constitution.md` (overwrite).

.github/prompts/implement.prompt.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -34,19 +34,19 @@ $ARGUMENTS
3434
- **Validation checkpoints**: Verify each phase completion before proceeding
3535

3636
5. Implementation execution rules:
37-
- **Setup first**: Initialize project structure, dependencies, configuration
37+
- **Setup first**: Initialize project structure, dependencies, and configuration
3838
- **Tests before code**: If you need to write tests for contracts, entities, and integration scenarios
39-
- **Core development**: Implement models, services, CLI commands, endpoints
40-
- **Integration work**: Database connections, middleware, logging, external services
41-
- **Polish and validation**: Unit tests, performance optimization, documentation
39+
- **Core development**: Implement models, services, CLI commands, and endpoints
40+
- **Integration work**: Database connections, middleware, logging, and external services
41+
- **Polish and validation**: Unit tests, performance optimization, and documentation
4242

4343
6. Progress tracking and error handling:
4444
- Report progress after each completed task
4545
- Halt execution if any non-parallel task fails
46-
- For parallel tasks [P], continue with successful tasks, report failed ones
46+
- For parallel tasks [P], continue with successful tasks and report failed ones
4747
- Provide clear error messages with context for debugging
4848
- Suggest next steps if implementation cannot proceed
49-
- **IMPORTANT** For completed tasks, make sure to mark the task off as [X] in the tasks file.
49+
- **IMPORTANT**: For completed tasks, make sure to mark the task as [X] in the tasks file.
5050

5151
7. Completion validation:
5252
- Verify all required tasks are completed

.github/prompts/tasks.prompt.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ $ARGUMENTS
3535
4. Task generation rules:
3636
- Each contract file → contract test task marked [P]
3737
- Each entity in data-model → model creation task marked [P]
38-
- Each endpoint → implementation task (not parallel if shared files)
38+
- Each endpoint → implementation task (not parallel if files are shared)
3939
- Each user story → integration test marked [P]
4040
- Different files = can be parallel [P]
4141
- Same file = sequential (no [P])
@@ -61,4 +61,4 @@ $ARGUMENTS
6161

6262
Context for task generation: $ARGUMENTS
6363

64-
The tasks.md should be immediately executable - each task must be specific enough that an LLM can complete it without additional context.
64+
The tasks.md should be immediately executable - each task must be specific enough that an LLM can complete it without requiring additional context.

.specify/memory/constitution.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -120,9 +120,9 @@ The `src/` folder contains the module source code that Build-PSModule compiles i
120120
- `data/` - Configuration data files (`.psd1`) loaded as module variables
121121
- `formats/` - Format definition files (`.ps1xml`) for object display
122122
- `functions/private/` - Private functions (internal implementation)
123-
- Supports subdirectories for grouping (e.g., `functions/public/CoponentA/`, `functions/public/ComponentB/`)
123+
- Supports subdirectories for grouping (e.g., `functions/public/ComponentA/`, `functions/public/ComponentB/`)
124124
- `functions/public/` - Public functions (exported to module consumers)
125-
- Supports subdirectories for grouping (e.g., `functions/public/CoponentA/`, `functions/public/ComponentB/`)
125+
- Supports subdirectories for grouping (e.g., `functions/public/ComponentA/`, `functions/public/ComponentB/`)
126126
- Optional category documentation files (e.g., `functions/public/PSModule/PSModule.md`)
127127
- `init/` - Initialization scripts (executed first during module load)
128128
- `modules/` - Nested PowerShell modules (`.psm1`) or additional assemblies

.specify/templates/plan-template.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,8 @@
1212
→ Set Structure Decision based on project type
1313
3. Fill the Constitution Check section based on the content of the constitution document.
1414
4. Evaluate Constitution Check section below
15-
→ If violations exist: Document in Complexity Tracking
16-
→ If no justification possible: ERROR "Simplify approach first"
15+
→ If violations exist: Document them in Complexity Tracking
16+
→ If no justification is possible: ERROR "Simplify approach first"
1717
→ Update Progress Tracking: Initial Constitution Check
1818
5. Execute Phase 0 → research.md
1919
→ If NEEDS CLARIFICATION remain: ERROR "Resolve unknowns"
@@ -35,15 +35,15 @@
3535

3636
## Technical Context
3737

38-
**Language/Version**: [e.g., Python 3.11, Swift 5.9, Rust 1.75 or NEEDS CLARIFICATION]
39-
**Primary Dependencies**: [e.g., FastAPI, UIKit, LLVM or NEEDS CLARIFICATION]
40-
**Storage**: [if applicable, e.g., PostgreSQL, CoreData, files or N/A]
41-
**Testing**: [e.g., pytest, XCTest, cargo test or NEEDS CLARIFICATION]
42-
**Target Platform**: [e.g., Linux server, iOS 15+, Wasm or NEEDS CLARIFICATION]
38+
**Language/Version**: [e.g., Python 3.11, Swift 5.9, Rust 1.75, or NEEDS CLARIFICATION]
39+
**Primary Dependencies**: [e.g., FastAPI, UIKit, LLVM, or NEEDS CLARIFICATION]
40+
**Storage**: [if applicable, e.g., PostgreSQL, CoreData, files, or N/A]
41+
**Testing**: [e.g., pytest, XCTest, cargo test, or NEEDS CLARIFICATION]
42+
**Target Platform**: [e.g., Linux server, iOS 15+, Wasm, or NEEDS CLARIFICATION]
4343
**Project Type**: [single/web/mobile - determines source structure]
44-
**Performance Goals**: [domain-specific, e.g., 1000 req/s, 10k lines/sec, 60 fps or NEEDS CLARIFICATION]
45-
**Constraints**: [domain-specific, e.g., <200ms p95, <100MB memory, offline-capable or NEEDS CLARIFICATION]
46-
**Scale/Scope**: [domain-specific, e.g., 10k users, 1M LOC, 50 screens or NEEDS CLARIFICATION]
44+
**Performance Goals**: [domain-specific, e.g., 1000 req/s, 10k lines/sec, 60 fps, or NEEDS CLARIFICATION]
45+
**Constraints**: [domain-specific, e.g., <200ms p95, <100MB memory, offline-capable, or NEEDS CLARIFICATION]
46+
**Scale/Scope**: [domain-specific, e.g., 10k users, 1M LOC, 50 screens, or NEEDS CLARIFICATION]
4747

4848
## Constitution Check
4949

.specify/templates/spec-template.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818
5. Generate Functional Requirements
1919
→ Each requirement must be testable
2020
→ Mark ambiguous requirements
21-
6. Identify Key Entities (if data involved)
21+
6. Identify Key Entities (if data is involved)
2222
7. Run Review Checklist
2323
→ If any [NEEDS CLARIFICATION]: WARN "Spec has uncertainties"
2424
→ If implementation details found: ERROR "Remove tech details"
@@ -88,7 +88,7 @@ Example of marking unclear requirements:
8888

8989
### Key Entities *(include if feature involves data)*
9090

91-
- **[Entity 1]**: [What it represents, key attributes without implementation]
91+
- **[Entity 1]**: [What it represents, key attributes without implementation details]
9292
- **[Entity 2]**: [What it represents, relationships to other entities]
9393

9494
---

0 commit comments

Comments
 (0)