How to Jam
0. Initialize the library with all the processes you need
Know what processes you need to create, then follow the Quick Start a Process Library from Scratch in Three Steps if you don't already have a Process Library created.
1. BOSS: Basic Outline Sections Steps
- Open an EBML file in your favorite text editor (e.g. Notepad, Sublime Text, etc.)
- If you are comfortable with EBML syntax, delete the commented blocks of text at the end of the file, otherwise just leave it there for reference
- Tweak the header information as needed, like Author, Revision, Subject, Product, etc. to taste
If you don't actually know how this process works, now's a good time to find the person who does... you will type while they talk!
This workflow is ideal for wasting as little time as possible from your valuable experts. Type out the procedure's sequence as human-readable notes in a plain text file during your discussion with your expert, then leave them alone. You can add the EBML to your notes after!
1.1 First pass: Outline the process with "Section" lines
Limit yourself to only using "Section" and "Section Reference" lines in the first pass.
Here's an example of what that can look like, using the "Sec" and "SecRef" aliases:
SecRef | SOP01 | Start
Sec | Do core steps
Sec | The other part
Sec | Verify requirements
Sec | Get more stuff done
Sec | Specific end steps
SecRef | SOP01 | End
The example above refers to another process in the same library with the Document Number "SOP01" and inserts sections named "Start" and "End" from that process into this one. See Section Reference (EBML Structure)
1.2 Second pass: "Step" lines
For the second pass, limit yourself to the "Step" line type, so that you strictly think through the order of operations for the process.
Here's an example of what that can look like, extending the previous pass into the first native section:
SecRef | SOP01 | Start
Sec | Do core steps
Step | Do this first
Step | Do this next
Step | We also need to do this
Step | Check your work
Step | Turn it in
Sec | The other part
Sec | Verify requirements
Sec | Get more stuff done
Sec | Specific end steps
SecRef | SOP01 | End
Fill in all the Steps for all the Sections (not the Section References though...).
Now's a good time run the EasyButton script toget a preview...
2. Image Placeholders
This is the point in the jamming process you know when the user needs visual aids. For instance, if you are authoring an assembly procedure, you might be envisioning screenshots or drawings from CAD at certain steps.
Restrict yourself to placeholder "Image" lines according to Image (EBML SubStep) guidelines. That might look like this, continuing our example:
...
Sec | Do core steps
Step | Do this first
Image | initial-state.png | This is an image of the first thing we need to do
Step | Do this next
Image | second-thing.png | This is the second thing to do
Image | second-thing-detailed.png | Zoom in on a critical area for the second thing
Step | We also need to do this
Step | Check your work
Image | check-your-work.png | This is how to check your work
Step | Turn it in
...
It's presumed that you don't actually have "initial-state.png" or "second-thing.png" etc.
We're going to create those later and drop them in the Process Folder, but for now we are focusing so we can get all of the actual process content into the document.
3. Other SubStep types
| File | ebmlKey | ebmlArguments |
|---|---|---|
| Action (EBML SubStep) |
|
|
| Command (EBML SubStep) |
|
|
| Context (EBML SubStep) |
|
|
| Image (EBML SubStep) |
|
|
| Objective (EBML SubStep) |
|
|
| Out of Scope (EBML SubStep) |
|
|
| Resource (EBML SubStep) |
|
|
| Table (EBML SubStep) |
|
|
| Verification (EBML SubStep) |
|
|
| Warning (EBML SubStep) |
|
|
If you really want some low-level documentation on SubSteps that is... less than practical while you're jamming, check out the stanhope source code documentation for Enum SubStep or perhaps even the SubStep extraction code lines themselves to see exactly how stanhope reads EBML within a particular step.
4. Generate all the Images
You have a nice-looking process, except for all the image placeholders. You can either keep jamming on other processes by repeating all of (1) above throughout the library, or you can focus and finish on this one process. That decision depends on how urgently you need this process.
4.1 Get a list of filenames
See Audit a Library for Missing Image Files and look for this process in the results.
The output will look something like this:
▛▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▜
▌ Library Graphics Audit ▐
▙▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▟
[ No missing images! ] SG-TP-STYL-202 - One SECREF to 201
[ No missing images! ] SG-TP-STYL-203 - One self-SECREF
[ No missing images! ] EB-WI-0010 - Start a New Process Library
[ No missing images! ] SG-TP-STYL-201 - One SECREF to 200
[ No missing images! ] SG-TP-STYL-103 - Basic Process Custom Compact
▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒ TC-SCRIPT-01 - Bash Script Example
▒▒▒▒▒▒▒▒▒▒▒ -> Missing Images
▒▒▒▒▒▒▒▒ posix-commands.png
▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒ EB-RP-900 - Merge Dev to Main
▒▒▒▒▒▒▒▒▒▒▒ -> Missing Images
▒▒▒▒▒▒▒▒ git-branch-dev.png
▒▒▒▒▒▒▒▒ merge-dev-to-main.png
[ No missing images! ] R-IP-THNG-001 - Install a Thing
In the example above, two processes have missing images: TC-SCRIPT-01 (posix-commands.png) and EB-RP-900 (git-branch-dev.png and merge-dev-to-main.png).
Now you have a punch-list of images to create for the process(es) you are jamming on!
4.2 Make your images!
As you create each image on your punch-list, be sure to:
- Save it to the Process Folder
- Change the filename to match your punch-list
You can periodically publish the process with the EasyButton script to check that the images look OK.