__ __ _____/ /_____ _____ / /_ ____ ____ ___ / ___/ __/ __ `/ __ \/ __ \/ __ \/ __ \/ _ \ (__ ) /_/ /_/ / / / / / / / /_/ / /_/ / __/ /____/\__/\__,_/_/ /_/_/ /_/\____/ .___/\___/ /_/ or... is it called __ __ __ ___ ___ ____ ________ __ / /_ __ __/ /_/ /_____ ____/__ \ / _ \/ __ `/ ___/ / / / / __ \/ / / / __/ __/ __ \/ __ \/ _/ / __/ /_/ (__ ) /_/ / / /_/ / /_/ / /_/ /_/ /_/ / / / /_/ \___/\__,_/____/\__, / /_.___/\__,_/\__/\__/\____/_/ /_(_) /____/ Yeah, what's the deal with the naming of this thing? The Goal: make process documents easy to produce and easy to use. Everyone should have the right version of good process documentation. Everyone should have access to previous runs of processes. Everyone should feel empowered to improve how we do our work together. ____ ___ ____ _ _ _ _ ____ ___ ____ [__ | |__| |\ | |__| | | |__] |___ ___] | | | | \| | | |__| | |___ stanhope is the software engine that reads EBML files and generates HTML and PDFs. - Windows, Mac, and Linux versions exist, and are free to download. - The software is open-source, meaning all of the source code is freely available. - stanhope is distributed under the GPL 3.0 license - Contributions to the code base come exclusively from US citizens employed by Strativus Group. ____ ____ ____ _ _ ___ _ _ ___ ___ ____ _ _ |___ |__| [__ \_/ |__] | | | | | | |\ | |___ | | ___] | |__] |__| | | |__| | \| Easy Button refers to the Easy Button Markup Language (EBML) and the script files called EasyButton (double-click, and it does everything for you!) _ _ ____ ____ ____ _ _ _ ____ ____ ____ _ _ ____ ___ _ ____ _ _ |\/| | | |__/ |___ | |\ | |___ | | |__/ |\/| |__| | | | | |\ | | | |__| | \ |___ | | \| | |__| | \ | | | | | | |__| | \| If you have internet access, all the README you'll need is on the internet. Links below help. General documentation, updated automatically with every release: - main web page: https://stanhope.strativusgroup.com/ - user guide: https://user-guide.stanhope.strativusgroup.com/ Nitty-Gritty generated for every release: - Rustdocs: https://stanhope.strativusgroup.com/doc/stanhope/ - unit test results: https://stanhope.strativusgroup.com/test_output.txt - regression libraries: https://test.stanhope.strativusgroup.com/ ___ ____ ____ ___ _ _ ____ ___ ____ _ _ ____ _ _ ____ ____ _ _ _ _ ____ ____ |__] |__/ | | | \ | | | | [__ \_/ | | | | | |__| |\ | | | [__ |___ | | \ |__| |__/ |__| |___ | ___] | |__| |__| |___ | | | \| |__| ___] |___ ____ _ _ ____ _ _ _ _ ____ |___ |\/| |__| | | | | [__ |___ | | | | | |___ |__| ___] Strativus Group would love to help you achieve process excellence - General inquiry: contact@strativusgroup.com - stanhope feature request or bug report: feature.request@stanhope.strativusgroup.com _ _ _ ___ ____ ____ ___ _ _ ___ ____ ____ _ ____ _ ____ | | | | \ |___ | | | | | | | | |__/ | |__| | [__ \/ | |__/ |___ |__| | |__| | |__| | \ | | | |___ ___] - Library quick start: https://youtu.be/OypODGEuXcA - Command line help: https://youtu.be/UDVNYA9Nd6o _ _ ____ _ _ _ ___ ____ _ ____ _ _ |__| | | | | | | | | | |__| |\/| | | |__| |_|_| | |__| _| | | | | Read the full thing (and more!) online at: https://user-guide.stanhope.strativusgroup.com/ This is the recommended workflow for Process development 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 Need help from your subject matter experts to write this process? 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 Note: 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 ... Note: 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 Action Command Context Image Objective Out of Scope Resource CSV Start CSV End CSV File Verification Warning 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. Repeat until there are no more placeholders or missing images in a graphics audit