Feature/7 living doc copilot#9
Draft
miroslavpojer wants to merge 35 commits into
Draft
Conversation
…DME and documentation for clarity
…nes and skill overview
…lete glossary file
…mpact tracing, and entity validation - Implemented `next_id.py` for auto-assigning IDs to user stories, features, functionalities, and acceptance criteria. - Created `compute_gaps.py` to analyze a catalog snapshot and identify gaps in documentation and testing coverage. - Developed `trace_impact.py` to trace the impact of code changes on features, functionalities, and user stories based on a catalog. - Added `validate_entity.py` to validate living doc entities against a canonical schema, ensuring required fields and referential integrity.
- Implemented `scan_ac_links.py` to check for missing or malformed AC link headers in Gherkin scenarios. - Validates AC ID format and checks for duplicates within the same feature file. docs: create gherkin-scenario skill documentation - Added `SKILL.md` for `gherkin-scenario` detailing standards for writing BDD scenarios in Gherkin. - Covers traceability requirements, language use, and anti-pattern avoidance. docs: create gherkin-step skill documentation - Added `SKILL.md` for `gherkin-step` outlining best practices for implementing Gherkin step definitions. - Emphasizes keeping steps thin, encapsulating selectors, and sharing state correctly. docs: create living-doc-pageobject-scan skill documentation - Added `SKILL.md` for `living-doc-pageobject-scan` detailing how to generate and maintain PageObject classes. - Describes modes for creating and maintaining PageObjects, including selector preferences and output artifacts. feat: add manifest diff script for PageObject validation - Implemented `manifest_diff.py` to compare the manifest against PageObject files on disk. - Identifies stale manifest entries and undocumented PageObjects. docs: create living-doc-scenario-creator skill documentation - Added `SKILL.md` for `living-doc-scenario-creator` detailing the process of generating BDD scenarios from User Stories. - Includes workflow steps for mapping acceptance criteria to scenarios and identifying missing steps. feat: add coverage report script for AC tracking - Implemented `coverage_report.py` to generate a report on AC coverage by Gherkin scenarios. - Scans feature files for AC links and compares them against User Stories to identify gaps.
- Updated Gherkin step definitions to remove Java and Scala references, focusing on Python behave and TypeScript Cucumber. - Enhanced Living Doc PageObject scan to include TypeScript examples and clarified output artifact locations. - Revised Living Doc Scenario Creator to improve missing step handling and stub generation, ensuring better integration with PageObjects. - Created a comprehensive implementation roadmap for the Agentic Engineering Toolkit, detailing progress, file layout, and validation checklists.
…n skills with new trigger phrases and improved descriptions
- Introduced trigger evaluations for Gherkin living doc sync to identify sync-related queries. - Added evaluation scenarios for Gherkin scenario creation, focusing on writing and reviewing BDD scenarios. - Implemented evaluations for Gherkin step definitions, emphasizing the distinction between Gherkin text and step binding code. - Created evaluations for living doc page object scanning, including bootstrap and maintain modes for PageObject generation. - Established evaluations for living doc scenario creation, generating BDD scenarios from user stories and handling coverage reports.
…s and new trigger phrases
…nality - Updated SKILL.md for living-doc-create-functionality to clarify Functionality naming and acceptance criteria elicitation. - Enhanced living-doc-create-user-story to streamline narrative elicitation and improve AC generation process. - Revised living-doc-gap-finder to normalize script output and report gaps more effectively. - Improved living-doc-impact-analysis to flag missing coverage and provide a re-test checklist. - Enhanced living-doc-pageobject-scan to better handle fragile selectors and update PageObjects. - Updated living-doc-scenario-creator to ensure accurate scenario generation and coverage reporting. - Refined living-doc-update to maintain AC ID stability and improve documentation practices. - Added gap-report.json to track documentation coverage and identify gaps in User Stories and Functionalities.
…-bdd-copilot agents
…y and completeness
…ntext and function naming conventions
…for living documentation analysis
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Closes #7.
This PR delivers the full Living Documentation agent suite — two new custom VS Code agents (
@living-doc-copilotand@living-doc-bdd-copilot) backed by 11 skills, automation scripts, eval suites, a shared glossary, and user-facing guides.Changes
Agents
@living-doc-copilot— Requirements-layer agent. Creates, updates, heals, and plans User Story / Feature / Functionality entities in the living doc catalog. Storage-format agnostic (prompts for a Storage Profile on first use).@living-doc-bdd-copilot— Automation-layer agent. Explores web apps via MCP Playwright, generates PageObjects, produces Gherkin scenarios and step definitions, and maintains the BDD suite through RE-SCAN / HEALING / REMOVE modes.evals.json+trigger-eval.json).Skills (living-doc domain)
living-doc-create-user-storyliving-doc-create-featureliving-doc-create-functionalityliving-doc-updateliving-doc-gap-finderliving-doc-impact-analysisliving-doc-scenario-creatorliving-doc-pageobject-scangherkin-scenariogherkin-stepgherkin-living-doc-syncEach skill ships with
evals.json,trigger-eval.json, fixture files, and ascripts/directory.Automation scripts
Python helpers bundled with each skill:
next_id.py— auto-increment entity IDs (create-* skills)compute_gaps.py— diff catalog vs test coverage (gap-finder)trace_impact.py— reverse-trace changed modules to living-doc entities (impact-analysis)validate_entity.py— schema-check entity YAML/JSON files (update)scan_ac_links.py— lint.featurefiles for AC link header compliance (gherkin-living-doc-sync)manifest_diff.py— detect PageObject drift between scan runs (pageobject-scan)coverage_report.py— map scenarios to AC coverage (scenario-creator)Shared reference
skills/references/living-doc-glossary.md— canonical term definitions shared across all living-doc skills.Documentation
docs/guides/living-doc-copilot.md— usage guide for@living-doc-copilotdocs/guides/living-doc-bdd-copilot.md— usage guide for@living-doc-bdd-copilotdocs/guides/token-saving.md— guide for the token-saving skilldocs/testing/agent-testing.md— how to run agent evalsdocs/testing/skill-testing.md— moved fromdocs/into thetesting/subfolderREADME.md,CONTRIBUTING.md,docs/README.md, anddocs/getting-started.mdCI
.github/workflows/check_pr_release_notes.yml(addedtitleparameter).Release Notes
@living-doc-copilotagent — maintains the living documentation catalog (User Stories, Features, Functionalities) directly from VS Code chat.@living-doc-bdd-copilotagent — crawls web apps with MCP Playwright and generates PageObjects, Gherkin scenarios, and step definitions tied to living doc ACs.living-doc-create-user-story,living-doc-create-feature,living-doc-create-functionality,living-doc-update,living-doc-gap-finder,living-doc-impact-analysis,living-doc-scenario-creator,living-doc-pageobject-scan,gherkin-scenario,gherkin-step,gherkin-living-doc-sync.skills/references/living-doc-glossary.md).evals.json+trigger-eval.json) for all new skills and agents.docs/guides/and testing documentation underdocs/testing/.docs/testing/skill-testing.mdmoved fromdocs/todocs/testing/.README.md,CONTRIBUTING.md,docs/README.md, anddocs/getting-started.mdupdated to reflect the new skill catalog.check_pr_release_notes.yml— added missingtitleparameter to release notes presence check.