Contents Menu Expand Light mode Dark mode Auto light/dark, in light mode Auto light/dark, in dark mode Skip to content
Speky 0.3.3.dev3+6ccf93f documentation
Logo
Speky 0.3.3.dev3+6ccf93f documentation
  • Requirements
    • Functional
      • MCP003 Get requirement by ID
      • MCP004 Get test by ID
      • MCP005 Search and filter requirements
      • MCP007 List requirements referencing another
      • MCP008 List all tags
      • MCP009 List all IDs
      • MCP010 Get test plan coverage for requirements
      • MCP011 Search and filter tests
      • SF001 Write requirements
      • SF002 PDF output
      • SF003 HTML output
      • SF004 Version controlled
      • SF005 Differential PDF
      • SF006 Support comments
      • SF007 Index requirements by tags
      • SF008 Quote client requirement
      • SF010 CSV for comments
      • SF011 Support free key:value
      • SF012 Input file validation
      • SF013 Parameterized tags
      • SF014 Project manifest
      • SF015 Code sources in manifest
      • SF016 Scan code for requirement references
      • SF017 Source links in manifest
    • Non-Functional
      • MCP001 Start server with specifications
      • MCP002 Multiple queries per session
      • SN001 Format is YAML or TOML
      • SN002 Do not constraint file names
      • SN003
      • SN004 Offline development
      • SN005 Apply fields to lists of comments
      • SN006 Use tree-sitter for code scanning
  • Tests
    • Functional
      • TF001 Writing requirements as text
      • TF002 Generate a PDF
      • TF003 Use Git for versionning
      • TF004 Add comments
      • TF005 Tags
      • TF006 Client requirement
      • TF007 CSVs
      • TF008 HTML output
      • TF009 Validating YAMLs
      • TF010 Writing properties
      • TF011 Parameterizing tags
      • TF012 Use a project manifest
      • TF013 Scan code for references
      • TMCP004 get_requirement with minimal fields
      • TMCP005 get_requirement with all fields
      • TMCP006 get_requirement errors on unknown ID
      • TMCP007 get_test with minimal fields
      • TMCP008 get_test with all fields
      • TMCP009 get_test errors on unknown ID
      • TMCP010 get_test errors on non-test ID
      • TMCP011 search_requirements returns all when unfiltered
      • TMCP012 search_requirements filtered by tag
      • TMCP013 search_requirements filtered by namespaced tag
      • TMCP014 search_requirements filtered by category
      • TMCP015 search_requirements errors on unknown tag
      • TMCP016 get_requirement errors on non-requirement ID
      • TMCP020 list_references_to returns referencing requirements
      • TMCP021 list_references_to returns empty list for unreferenced requirement
      • TMCP022 list_references_to errors on unknown ID
      • TMCP024 list_all_tags returns unique tags sorted
      • TMCP025 list_all_tags returns empty list when no tags
      • TMCP029 list_all_ids returns all requirement and test IDs sorted
      • TMCP030 list_all_ids includes IDs from all categories
      • TMCP031 search_requirements errors on unknown category
      • TMCP032 test_plan_coverage partitions requirements into coverage buckets
      • TMCP033 test_plan_coverage filtered by category
      • TMCP034 test_plan_coverage filtered to category with no gaps
      • TMCP035 test_plan_coverage errors on unknown category
      • TMCP036 search_tests returns all tests when unfiltered
      • TMCP037 search_tests filtered by category
      • TMCP038 search_tests filtered by tester_of
      • TMCP039 search_tests filtered by category and tester_of
      • TMCP040 search_tests returns empty list when tester_of has no tests
      • TMCP041 search_tests errors on unknown category
      • TMCP042 search_tests errors on unknown tester_of
      • TMCP043 get_requirement includes code references
      • TMCP044 get_test includes code references with is_test flag
    • Non-Functional
      • TMCP001 Start the MCP server
      • TMCP002 Reject invalid specifications
      • TMCP003 Initialize the MCP server
  • Tags
  • Test Coverage
Back to top
View this page

SN001 Format is YAML or TOMLΒΆ

The requirements, functional tests and comments can be written in YAML or TOML format.

Properties

version: 3

Tested by

TF001 Writing requirements as text

References

Relates to: SF001 Write requirements

Source

Source file: specs/nonfunctional.yaml

Loaded from: speky

Implemented in: read_file

Next
SN002 Do not constraint file names
Previous
MCP002 Multiple queries per session
Copyright © 2025
Made with Sphinx and @pradyunsg's Furo