Skip to content

Commit

Permalink
Clarify OSPS-SA-02 (#154)
Browse files Browse the repository at this point in the history
Signed-off-by: Evan Anderson <[email protected]>
  • Loading branch information
evankanderson authored Jan 28, 2025
1 parent 4b86454 commit 9ae5930
Showing 1 changed file with 8 additions and 2 deletions.
10 changes: 8 additions & 2 deletions baseline/OSPS-SA.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -35,16 +35,22 @@ criteria:
maturity_level: 2
criterion: |
The project documentation MUST include
descriptions of all external input and output
descriptions of all external software
interfaces of the released software assets.
rationale: |
Provide users and developers with an
understanding of how to interact with the
project's software and integrate it with
other systems, enabling them to use the
software effectively.
implementation: |
The project README should include a link to
the API documentation, often under a header
such as "Usage", "API Reference", or "Docs".
Documentation badges should also be considered
when recognized (e.g. readthedocs, godoc, etc.).
details: |
Document all input and output interfaces of
Document all software interfaces (APIs) of
the released software assets, explaining how
users can interact with the software and
what data is expected or produced.
Expand Down

0 comments on commit 9ae5930

Please sign in to comment.