Skip to content

Allows writing of spec in yaml format and converts to HTML for reading

Notifications You must be signed in to change notification settings

tzmedical/yaml-spec

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

19 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

##Development Modify code on gh-pages branch

##Usage Spec viewer hosted at this link

Paste yaml spec in text area to see all requirements, specifications and tests

##Format

categories:
  - name: Category Name
    regulatory: ISO 60601, ISO 62366
    subcategories:
      - name: Subcategory Name
        requirements:
          - description: Requirements should contain 'must' or 'should' or similar
            specifications:
              - description: Specification will contain text about how requirement will be met
                tests:
                  - method: Test Procedure (12345)
                    result: Test Report (12346)
                    criteria: Test passes
                    unit: Backend
                    dependencies: unit #unused atm, use for dependencies between groups of tests in CI system

##Autogenerated CSVs for documentation

About

Allows writing of spec in yaml format and converts to HTML for reading

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 3

  •  
  •  
  •