search

inbo / protocolhelper

Helper functions and templates to manage the INBO/protocols repository.
https://inbo.github.io/protocolhelper/
GNU General Public License v3.0
5 stars 0 forks source link

Standard structure of SOP, SAP, SFP, SPP - to be discussed? #78

Closed Eveltjen00 closed 2 years ago

Eveltjen00 commented 2 years ago

I think it would be worthwhile brainstorming on the structure of the documents so they are applicable to all teams/procedures. Personally, I prefer a SOP that is to the point; with extra information (definitions, context) in the back/appendices for completeness.

  1. Main changes compared to previous version (so that someone familiar with the procedure, knows what has changed)
  2. Abstract (= Goal, Scope, Not in Scope + where to find information on what's not in scope if existing)
  3. Preparations
    • Safety; vaccinations, protective clothing, warnings of dangerous chemicals, emergency protocols (should be in the beginning!)
    • Material (Equipment, Labeling, Data registration (GPS, sampling table, tablet, phone, …))
    • Human resources; Which roles and why? Minimal number of people needed for this procedure? Skillset/training needed for this procedure?
    • Dependencies on other procedures: Should another procedure be known/studied prior to executing this procedure?
  4. Visualized procedure - Flowchart (can be optional but should be encouraged when helpful)
  5. Step-by-step procedure - written text (including quality assurance) and best is also to include visual aid (photo's, diagrams, ..)
  6. Definitions
  7. References
  8. Appendices (including principles, context, more explanation, perhaps extra photos, ..)

ps: this structure does not apply to SIPs.

To be discussed?

florisvdh commented 2 years ago

it would be worthwhile brainstorming on the structure of the documents

Always :+1:. Thanks for contributing ideas BTW. I assume @hansvancalster will come back to this.

hansvancalster commented 2 years ago

Thanks for opening this issue. I will schedule a live meeting to discuss this further. We can then report back here with whatever we decide to do.

hansvancalster commented 2 years ago

We discussed this and decided to add this next to the other protocol templates as a "generic" template. This will become part of v0.4.0 of protocolhelper.