OS2offdig / governance_report_template

OS2's governance checkliste der benyttes til at belyse niveauet af et OS2 produkt.
https://os2.eu/governance
0 stars 3 forks source link

Elaborate and merge F7, F8, F9 criterias #26

Closed janhalen closed 2 weeks ago

janhalen commented 2 months ago

What part needs to change?

F7  Driftskrav til løsningen er dokumenteret    
F8  Løsningen er dokumenteret på teknisk niveau     
F9  Teknisk implementering af løsningen er dokumenteret

Obstacle

These criteria can be confusing and some parts even overlapping..

Background

Propose solution

This criteria should follow the "Document the code" criteria from Foundation for Puclic Code.

References

https://standard.publiccode.net/criteria/document-the-code.html

https://dzone.com/articles/the-anatomy-of-a-great-open-source-documentation-h

janhalen commented 2 months ago

Add to the criteria that the way the documentation should be written somewhat along these lines: "Os2 anviser dokumentations skabelonen placeret.. -> link" "OS2 follow the documentation requirements from Foundation for Public code"

@zorp, any comments?

janhalen commented 2 months ago

This criteria and specifically the "how-to" document should be linked to the https://github.com/OS2offdig/os2-docs-template.

Moved to https://github.com/OS2offdig/governance_report_template/issues/36

janhalen commented 2 months ago

@zorp - SFPC criteria now mentioned in the template README --> https://github.com/OS2offdig/os2-docs-template/blob/main/README.md

janhalen commented 1 month ago

Proposal:

Merge F7, F8 and F9 into a new F7 criteria: "Alt dokumentation til projektet udarbejdes med og overholder OS2s standardskabelon for dokumentation."