Skip to content

Writing Specifications

Home › How-to Guides › Eac › Specifications

Learn how to write and manage BDD/Gherkin specifications for your modules.

Coming Soon

This section will provide comprehensive guides on:

Manual Specification Writing

  • Understanding Gherkin Syntax - Feature, Rule, Scenario, Given/When/Then structure
  • The Rule/Scenario Pattern - EAC's preferred specification organization approach
  • Writing Clear Scenarios - Best practices for readable, maintainable specifications
  • Step Definition Guidelines - Creating reusable, composable steps

Specification Organization

  • Organizing Specs by Module - Where to place specification files
  • File Naming Conventions - Consistent naming for discoverability
  • Grouping Related Features - Logical organization strategies

Tags and Metadata

  • Using @tags - Categorizing and filtering scenarios
  • Control Tags (@control) - Linking specifications to compliance requirements
  • Tag Contracts - Understanding valid tags and their meanings
  • Test Suite Organization - Using tags to create test suites

Specification Quality

  • Validation Rules - Understanding EAC's specification contract
  • Common Pitfalls - Avoiding anti-patterns
  • Refactoring Specifications - Improving existing specs
  • Review Checklist - Ensuring quality before commit

AI-Generated vs Manual Specifications

  • When to Use create spec - Leveraging AI for initial generation
  • When to Write Manually - Scenarios requiring human expertise
  • Editing Generated Specs - Refining AI output
  • Best of Both Worlds - Hybrid workflows

While this section is being developed, see:

Reference Documentation

For detailed specification contracts and validation rules:

→ Specification Reference (Coming)

Tutorials | How-to Guides | Explanation | Reference

You are here: How-to Guides — task-oriented recipes that guide you through solving specific problems.