Skip to content

Add feature requirements documentation structure#2

Merged
rradica merged 4 commits into
mainfrom
claude/feature-docs-setup-pkmeoj
Jul 9, 2026
Merged

Add feature requirements documentation structure#2
rradica merged 4 commits into
mainfrom
claude/feature-docs-setup-pkmeoj

Conversation

@rradica

@rradica rradica commented Jul 9, 2026

Copy link
Copy Markdown
Owner

Summary

This PR introduces a standardized documentation structure for feature requirements in the project. It establishes a dedicated Features/ folder with a reusable template and workflow guidelines to ensure consistent feature documentation across the team.

Key Changes

  • Added Features/feature-vorlage.md: A comprehensive German-language template for documenting feature requirements, including sections for overview, goals, functional/non-functional requirements, acceptance criteria, and references
  • Added Features/README.md: Documentation of the feature documentation workflow, guiding developers on how to use the template and organize feature files
  • Updated AGENTS.md: Added a new "Feature requirements" section that references the new documentation structure and explains where and how to document new features

Notable Details

  • The template uses a clear, structured format with checkboxes for tracking requirements and acceptance criteria
  • Documentation is language-agnostic in structure but uses German labels (reflecting the project's language preference)
  • The workflow encourages one feature per Markdown file with descriptive naming conventions
  • Integration with the main project README ensures discoverability and adoption of the new documentation standard

https://claude.ai/code/session_01D613xzzyazqaG34uMm4AZu

claude added 3 commits July 8, 2026 08:46
Merge main brought in the canonical AGENTS.md; move the Features folder
reference there and remove the duplicate lowercase Agents.md.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01D613xzzyazqaG34uMm4AZu

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request introduces a structured process for documenting feature requirements by adding a new Features/ directory. This directory includes a template (feature-vorlage.md) and a guide (README.md) in German, and AGENTS.md is updated to reference this new workflow. The feedback suggests a minor grammatical correction in the Features/README.md file to maintain consistency by using imperative verbs across all steps.

Important

The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.

Comment thread Features/README.md Outdated
1. Kopiere die Vorlage [`feature-vorlage.md`](./feature-vorlage.md).
2. Benenne die Kopie sprechend (z. B. `login-mit-sso.md`).
3. Fülle die Abschnitte der Vorlage aus.
4. Pro Feature eine eigene MD-Datei anlegen.

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The list of steps uses imperative verbs for steps 1-3 ('Kopiere', 'Benenne', 'Fülle') but switches to an infinitive verb construction in step 4 ('anlegen'). To maintain grammatical consistency, step 4 should also use the imperative form.

Suggested change
4. Pro Feature eine eigene MD-Datei anlegen.
4. Lege pro Feature eine eigene MD-Datei an.

Addresses review feedback: keep all workflow steps in the imperative form.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01D613xzzyazqaG34uMm4AZu
@rradica rradica merged commit e9e3d75 into main Jul 9, 2026
1 check passed
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.

2 participants