Jalon
From DuxWare Manual
Jump to navigationJump to searchContents
Manual Writing Process
Procedure to create a document 1) Brain Dump - Have an idea/summary of what the document is for. 2) Create a set of Leaning Objectives the READER will learn AFTER reading the document. 3) Create Initial Document Structure based on Brain Dump - This is the initial table of contents. 4) Review the ToC and sanity check it - to start with include EVERYTHING. Learning Objectives vs ToC - Learning Objectives - bullet points of something the reader will know afetr reading the document. - ToC - Starts as questions, envolves over time into 'Headings' or 'Sub Sections' - Sub Section - Expect to have Sections and Multple Sub Sections. 5) Begin Organizing ToC - related, easy vs hard. 6) Composition of Sub Sections Understand the important of TL;DR - Too Long;Didn't Read. - Add a Summary - Simplify ALWAYS - KISS - Long explanations are BAD - but useful to the right reader. - Bullets and List and Tables = WIN - Diagrams are better. 7) Come back later to self-proof sections 8) Cyclic Review/Additions/Proof/Peer Review - Keep going back to all the sections, add new ones, expand, fine tune, don't overthink. 9) Ask the question: Did I enable the reader to achieve the Learning Objectives. - Yes - You are done. - No - Do it again. 10) Test it! 11) Markup, Cleanup
New Pages in Progess
Operation Jalon is Awesome
Teaching Principles of Written Text - Text Books - Tutorial vs How-to vs Reference
Document Writing/Copy Writing + Images/Diagrams
Large Document Design Large Document Structure Indexing/ToC/References/External Links/See Also
Document Style - Consistancy
WIKI Page Linking and Structure
WIKI Markup
Image Tools Diagram Tools How to make good diagrams