Documentation Norms: capturing editable sources for images

[dlemire60]

In an appendix to Documentation Norms (EDIT, 8/3/2022, updated link: https://github.com/oasis-tcs/openc2-tc-ops/blob/main/Documentation-Norms.md#c3-creating-images-and-editable-sources) it's suggested to create a folder in the document repo to hold editable image sources (e.g., /src). There are a some special cases where we might want to provide more explicit guidance:

1. Downloaded images from Diagrams.net (formerly Draw.io) embed an editable version of the image within the PNG, JPEG, etc. You can upload the image and Diagrams.net will extract the editable content and allow you make changes. So the image is its own editable source, but that's not true for raster formats generally. One solution is to place a copy of the image in both /images and /src. Another possibility is a naming convention to convey info about the file, e.g., image1.ddn.png (where DDN = diagrams dot net).

2. Text sources that drive image generators like PlantUML. The generated image should go in the /images folder, as normal. The text source can go into the /src folder, but some indication is needed of where that source can be used. Potential approaches are:

• A comment in the text identifying the associated generator
• A naming scheme similar to the suggestion in item Update FAQ.md #1 (e.g., image1.plant.txt
• An index file in the /src folder associating text files with generators

3. For Google Draw images, need a general way of documenting the URL (and owning account?) of the image source.

There might be other cases I haven't thought of.