Flowcharting DITA
1 like1,763 views
The document discusses flowcharting procedures in DITA (Darwin Information Typing Architecture). It describes converting traditional flowcharts to a DITA task format using elements like <context>, <step>, and <choices>. This allows nesting child tasks within steps and avoiding trouble tables. The presentation encourages driving DITA beyond current uses by fully leveraging its capabilities for interactive media and nested procedures.
Flowcharting DITA
- 1. FLOWCHARTING DITA JANG F.M. GRAAT
- 2. WHO’S TALKING ? • Jang F.M. Graat • Amsterdam, NL • Psychology, Philosophy • 25+ years Tech Comms • 5+ years DITA • XML, XSLT, JS, PHP, etc. • Geek Philosopher
- 3. WHAT IS THE PROBLEM ?
- 4. 1. Unscrew and remove the oil inlet cap 2. Check the current oil level a) Clean the oil gauge b) Insert the oil gauge as far as it goes c) Remove the oil gauge d) Check the oil level on the gauge 3. If the level is below the minimum (A) a) Add some fresh oil (see specs) b) Repeat step 2) 4. Place and tighten the oil inlet cap A OPTIONAL PROCEDURE STEPS
- 5. Oil Level Cold Check ! Perform engine oil level COLD CHECK as follows: 1 For pre-ride inspection with the vehicle on jiffy stand on level ground, remove and wipe off the dipstick. Install the dipstick back into the oil tank. NOTE: For FXCWC models, thread the filler cap onto the spout until tight. On all other models, push the filler cap until fully seated in the spout. ! 2 See Engine Oil Level: Softail Models (Typical). Remove the dipstick and verify oil registers on the dipstick between the two marks. BRANCHING PROCEDURES ! a If oil level registers on the dipstick, proceed to Oil Level Hot Check. b If oil does not register on the dipstick, proceed to step 3. ! 3 With the dipstick removed, look into the dipstick opening and verify the oil level is at the filler neck weld. ! a If the oil level is at or near the filler neck weld, proceed to Oil Level Hot Check. b If the oil level is not at or near the filler neck weld, add only enough oil to bring the level to the filler neck weld. Then proceed to Oil Level Hot Check. !!
- 6. Oil Level Cold Check COLD CHECK as follows: For pre-ride inspection with the vehicle on jiffy stand on level ground, remove and wipe off the dipstick. Install the dipstick back into the oil tank. NOTE: For FXCWC models, thread the filler cap onto the spout until tight. On all other models, push the filler cap until fully seated in the spout. ! 2 See Engine Oil Level: Softail Models (Typical). Remove the dipstick and verify oil registers on the dipstick between the two marks. a If oil level registers on the dipstick, proceed to Oil Level Hot Check. b If oil does not register on the dipstick, proceed to step 3. ! 3 With the dipstick removed, look into the dipstick opening and verify the oil level is at the filler neck weld. ! a If the oil level is at or near the filler neck weld, proceed to Oil Level Hot Check. b If the oil level is not at or near the filler neck weld, add only enough oil to bring the level to the filler neck weld. Then proceed to Oil Level Hot Check. BRANCHING PROCEDURES !! Hot Check ! Perform engine oil level HOT CHECK as follows: ! 1 Ride motorcycle until engine is at normal operating temperature. NOTE: The engine will require a longer warm up period in colder weather. ! 2 With the vehicle upright on level ground, allow engine to idle for 1-2 minutes. Turn engine off. 3 With vehicle on jiffy stand remove and wipe off the dipstick. Install the dipstick back into the oil tank. ! NOTE: ! For FXCWC models, thread the filler cap onto the spout until tight. On all other models, push the filler cap until fully seated in the spout. ! 4 See Engine Oil Level: Softail Models (Typical). Remove the dipstick and note the level of the oil. Add only enough oil to bring the level to the FULL mark on the dipstick. Do not overfill. NOTE: ! Refer to Recommended Engine Oils. Use only recommended oil specified under Engine Lubrication. ! 5 Start engine and carefully check for oil leaks around drain plug and oil filter.
- 8. THIS CAN GET COMPLICATED
- 9. NOT A GOOD SOLUTION
- 11. WHY NOT USE REAL (VS. MENTAL) FLOWCHARTS ?
- 15. BASIC NODES • Start • Process (including inputs) • Decision • Yes/No • Multiple choices • End
- 16. <context> <p>Checking the oil level will prevent serious damage and does not require tools.</p> </context> START = CONTEXT / PREREQ
- 17. <step> <cmd>Remove the oil inlet cap</cmd> <info>The oil inlet cap is on the bottom right side of the engine.</info> </step> PROCESS = STEP (+ INFO ETC.)
- 18. <step> <cmd>Which model ?</cmd> <choices> <choice>Softail</choice> <choice>FSCWC</choice> </choices> </step> DECISION = STEP + CHOICES
- 19. <postreq> <p>Check the oil level again after riding the next 100 miles.</p> </postreq> END = POSTREQ
- 20. <task id="task_zph_dnq_vp"> <title>Replacing the oil</title> <taskbody> <context> <p>Checking the oil level will prevent serious " " damage and does not require tools.</p> </context> <steps> <step id="step1"> <cmd>Remove the oil inlet cap</cmd> <info>The oil inlet cap is on the bottom " " right side of the engine.</info> </step> <step id="step2"> <cmd>Remove dipstick and wipe it clean.</cmd> </step> <step id="step3"> <cmd>What is the bike model?</cmd> <choicetable> <chrow> <choption>Softail</choption> <chdesc>Continue with step 4</chdesc> </chrow> <chrow> <choption>FSCWC</choption> <chdesc>Continue with step 5</chdesc> </chrow> </choicetable> </step>" " … TRANSFORM TO DITA
- 26. NESTING TASKS IN STEPS
- 27. NO MORE TROUBLE TABLES
- 28. NO MORE ANCIENT METHODS
- 29. DRIVING DITA OFF THE MAP
- 30. QUESTIONS ? • @4everJang • jang@jang.nl • www.ditadocs.com • www.writeless.eu • www.jang.nl