GRCLibrary.ai

Guide

Worked Example: Converting a Draft into a CC BY-SA 4.0 Artefact

This walkthrough shows how a draft becomes a library-canonical artefact in this library. The example traces a hypothetical short procedure from rough notes through to a committed file. It is for adopters and contributors who want to see the ingestion specification applied end to end. This example covers ingestion (getting a new artefact into the library); for the reverse direction, following one adopter from clone through a staged programme, see the companion docs/worked-example-adoption.md.

Type
Guide
Version
1.0.7
Date
2026-08-15
Owner
Governance Library Maintainer
Approving authority
Governance Library Maintainer
Classification
Public
Confidentiality
Public
Category
Documentation
Review frequency
Annual and upon material change to the ingestion specification or the worked example's source procedure
Licence
CC BY-SA 4.0

Read the full text on GitHub (opens in a new tab)

Outline

  • Starting material
  • Step 1: pick the document type
  • Step 2: pick the domain and filename
  • Step 3: apply the organization-neutrality rules
  • Step 4: replace person- and team-specific text with role-based language
  • Step 5: write the canonical metadata block
  • Step 6: write the body
  • Step 7: add to the index and domain README
  • Step 8: run the local audits
  • Step 9: commit
  • Step 10: open a pull request
  • Common pitfalls
  • Summary

Related documents