Skip to content

Add comprehensive user guide documentation#40

Merged
Malcolmnixon merged 3 commits intomainfrom
copilot/add-user-guide-document
Jan 10, 2026
Merged

Add comprehensive user guide documentation#40
Malcolmnixon merged 3 commits intomainfrom
copilot/add-user-guide-document

Conversation

Copy link
Contributor

Copilot AI commented Jan 9, 2026

Adds user guide at docs/guide/guide.md covering ReqStream usage, YAML format specification, and common workflows.

Contents

  • Introduction: Overview of ReqStream's purpose and capabilities
  • Installation: Global and local tool installation via .NET CLI
  • Requirements File Format: Complete YAML specification including:
    • Hierarchical sections and subsections
    • Requirement IDs, titles, and child relationships
    • Test mappings (inline and separate)
    • File includes with automatic section merging
  • Command-Line Interface: Full option reference with usage patterns
  • Exporting: Requirements reports and trace matrix generation
  • FAQ: 30+ questions covering usage, format, mapping, and troubleshooting

Example YAML Structure

sections:
  - title: "System Security"
    requirements:
      - id: "SYS-SEC-001"
        title: "The system shall support credentials authentication."
        children:
          - "AUTH-001"

  - title: "User Authentication"
    requirements:
      - id: "AUTH-001"
        title: "All requests shall have their credentials authenticated."
        tests:
          - "Credentials_Valid_Allowed"
          - "Credentials_Invalid_Refused"

includes:
  - additional_requirements.yaml

mappings:
  - id: "AUTH-001"
    tests:
      - "Credentials_Missing_Refused"

Changes

  • Created docs/guide/guide.md (734 lines)
  • Added "Pandoc" to .cspell.json dictionary
Original prompt

This section details on the original issue you should resolve

<issue_title>[Feature]: User Guide document</issue_title>
<issue_description>### Problem Statement

The product should have a user guide.

Proposed Solution

A detailed user guide should be created in Markdown as docs/guide/guide.md.

It should have at least the following sections:

  • Introduction
    • What is it
    • How should it be used
    • Key features
  • Prerequisites
  • Requirements File Format
  • Exporting
  • FAQ

Alternatives Considered

No response

Additional Context

No response

Priority

Medium - Would improve workflow

Contribution

  • I would be willing to submit a PR for this feature

Code of Conduct

  • I agree to follow this project's Code of Conduct</issue_description>

Comments on the Issue (you are @copilot in this section)


✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

Copilot AI and others added 2 commits January 9, 2026 14:55
- Create docs/guide/guide.md with complete user documentation
- Include introduction, prerequisites, installation instructions
- Document YAML requirements file format with examples
- Detail command-line interface and all options
- Explain exporting capabilities for reports and trace matrices
- Add comprehensive FAQ covering 30+ common questions
- Follow markdown linting rules (120 char max, ATX headers)
- Use reference-style links throughout
- Provide practical examples for all features
Co-authored-by: Malcolmnixon <1863707+Malcolmnixon@users.noreply.github.com>
Copilot AI changed the title [WIP] Add user guide document in Markdown format Add comprehensive user guide documentation Jan 9, 2026
Copilot AI requested a review from Malcolmnixon January 9, 2026 14:59
@Malcolmnixon Malcolmnixon marked this pull request as ready for review January 10, 2026 03:42
@Malcolmnixon Malcolmnixon merged commit c2d1514 into main Jan 10, 2026
12 checks passed
@Malcolmnixon Malcolmnixon deleted the copilot/add-user-guide-document branch January 10, 2026 03:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Feature]: User Guide document

2 participants