Presentation is loading. Please wait.

Presentation is loading. Please wait.

1Proprietary to Trillium Creating Documentation Standards for the Web Trillium Technical Communications and Training.

Similar presentations


Presentation on theme: "1Proprietary to Trillium Creating Documentation Standards for the Web Trillium Technical Communications and Training."— Presentation transcript:

1 1Proprietary to Trillium Creating Documentation Standards for the Web Trillium Technical Communications and Training

2 2Proprietary to Trillium Why Different Standards People access informatio n differently People have different uses for the medium What works for one medium may not work for the other

3 3Proprietary to Trillium Why Different Standards Paper-based to web-based: More than just a conversion!

4 4Proprietary to Trillium Online Standards and Guidelines writing Editing I ndexing Internationalisation F o r m a t t i n g Graphics TRAINING

5 5Proprietary to Trillium Online Writing The difference:  Hypertext writing is non-linear in structure  Ideas are not presented sequentially  Information is presented in chunks

6 6Proprietary to Trillium Online Writing Guidelines 5-point Content Guideline The reader can make sense if the content has: 1.A beginning and an end 2.Continuous logic 3.A well-defined structure 4.Hierarchies that enable preference and choice 5.Flexible entry and exit points

7 7Proprietary to Trillium Online Writing Guidelines 5-point Brevity Guideline 1.Use bulleted lists 2.Write telegraphic language 3.Construct short paragraphs around main topics 4.Explain key points early 5.Link (or layer) detailed information to the main page

8 8Proprietary to Trillium Online Writing Guidelines 5-Point Structure Guideline 1.Segment information types 2.Write clear instructions that are easy to scan 3.Use real world examples 4.Use graphics to depict nebulous linear concepts

9 9Proprietary to Trillium Online Writing Guidelines The great scrolling debate… If the information is well-written, people will scroll

10 10Proprietary to Trillium Online Writing Guidelines 5-Point Navigation Guideline 1.Identify hyperlinks 2.Ensure that links clearly reveal intended destination 3.Avoid overusing links 4.The crux of the information should be on the main page 5.Hyperlinks should contain supplementary information

11 11Proprietary to Trillium Online Writing Guidelines The remaining 5 points… 1.Know your audience, then adapt to them 2.Determine and decide on goals and objectives 3.Formulate style of writing based on genre 4.Aim for a seamless flow of information 5.Use visual dimensions

12 12Proprietary to Trillium Online Editing Standards A few tips from Shirley:  Edit more for brevity than completeness  Do use references  Avoid using pointers such as: As you may recall,...As previously described,... and As aforementioned,......explained later, or earlier  Be careful with transitional words such as previous, following, and next

13 13Proprietary to Trillium Online Indexing Guidelines “Do have an index”, urges Kim  Key online navigational element  Online readers want specific information and now  Slow graphics and misleading links lose readers

14 14Proprietary to Trillium Online Indexing Guidelines A Search engine differs from an Index as it:  Provides every instance of a term  Does not point to related topics  Does not discriminate between relevant and irrelevant references  Cannot anticipate the readers’ needs

15 15Proprietary to Trillium Online Indexing Guidelines Eliminate Excessive Entries Make Entries Descriptive Make Entries Conceptual

16 16Proprietary to Trillium Online Internationalisation Guidelines Excerpts from Rahel’s presentation:  Use icons that most people can relate to  Pay attention to placement of information  Ensure consistency and “brand” your look  Ensure that the layout is as intuitive as possible  Use symbols and graphics

17 17Proprietary to Trillium Online Internationalisation Guidelines  Have indexes in key languages  Have the main page in key languages  Present country-specific information  Have a grid with major and minor categories that leads you to specific information  Provide multiple pathways to the information

18 18Proprietary to Trillium Online Formatting Standards Lessons learnt by our Design and Production team:  Prepare text for the lowest common denominator screen  Keep indenting minimal  Have page breaks at the level 2 or level 3 headings

19 19Proprietary to Trillium Online Formatting Standards  Colour  Blend with or use the company’s colours  Headings: Can include colour within moderation  Tables: Can include colour in cell headings  Links: Active and visited links should blend with the colours you might include in headings or table headers Don’t go overboard!

20 20Proprietary to Trillium Online Formatting Standards  Search  Hypertext TOC, LOF and LOT  Full index  Search engine  Glossary Do go overboard!

21 21Proprietary to Trillium Online Graphic Standards  Include fun, colourful icons for notes, warnings, or reminders   For highly technical documents, adding colour to detailed graphics can be annoying  Detail is preferred over colour

22 22Proprietary to Trillium Online Graphic Standards  Use GIF format for online graphics  Concentrate on making graphic improvements to your source file if you convert graphics

23 23Proprietary to Trillium Online Training Guidelines Michelle says…  Keep in mind that an instructor will not be present  Flesh out the content  Enhance graphics  Provide additional methods of information  Translate classroom interactivity to the web

24 24Proprietary to Trillium Online Training Guidelines  Include self-assessments  Have pre-tests and post-tests  Have a tracking and scoring mechanism in place  Have bookmarks

25 25Proprietary to Trillium Online Training Guidelines  Modify evaluation criteria  Modify usability heuristics  Have a stringent testing process  Communicate when you add new class material

26 26Proprietary to Trillium MUM’s the word- Make Use of the Medium! An Acronym to Take Away

27 27Proprietary to Trillium This was a presentation by: Shirley Pak, Technical Communicator Kim Pendergest, Technical Communicator Rahel Bailie, Sr. Technical Communicator, Team Lead-Vancouver Michelle Semrad, Instructional Designer Leigh Cook, Information Designer Sandhya Shyam Prasad, Director Technical Communications and Training, Trillium Digital Systems, an Intel company Feedback? Suggestions? Do us at


Download ppt "1Proprietary to Trillium Creating Documentation Standards for the Web Trillium Technical Communications and Training."

Similar presentations


Ads by Google