Successfully reported this slideshow.
We use your LinkedIn profile and activity data to personalize ads and to show you more relevant ads. You can change your ad preferences anytime.

MSTP

5,625 views

Published on

Manual Styles for Technical Publications -- Rajesh Singamsetty

Published in: Technology
  • I have always found it hard to meet the requirements of being a student. Ever since my years of high school, I really have no idea what professors are looking for to give good grades. After some google searching, I found this service ⇒ www.WritePaper.info ⇐ who helped me write my research paper. The final result was amazing, and I highly recommend ⇒ www.WritePaper.info ⇐ to anyone in the same mindset as me.
       Reply 
    Are you sure you want to  Yes  No
    Your message goes here
  • Writing a good research paper isn't easy and it's the fruit of hard work. For help you can check writing expert. Check out, please ⇒ www.HelpWriting.net ⇐ I think they are the best
       Reply 
    Are you sure you want to  Yes  No
    Your message goes here
  • The professtional essay writer are having more knowledege about the writing papers. The professional essay writer are providing the best essay writing services papers to the students. The writeersity writing company had to providing the more writing papers for the professtionalist. The papers should be very quality and possible to acedemic success. ⇒ www.HelpWriting.net ⇐ Good luck!
       Reply 
    Are you sure you want to  Yes  No
    Your message goes here
  • Sex in your area is here: ♥♥♥ http://bit.ly/2Q98JRS ♥♥♥
       Reply 
    Are you sure you want to  Yes  No
    Your message goes here
  • Dating direct: ❶❶❶ http://bit.ly/2Q98JRS ❶❶❶
       Reply 
    Are you sure you want to  Yes  No
    Your message goes here

MSTP

  1. 1. Style Guides<br />Course code - CMTEU - 003<br />
  2. 2. What is a Style Guide?<br /> A style guide or style manual is a set of standards for the writing and design of documents, either for general use or for a specific publication, organization or field. The implementation of a style guide provides uniformity in style and formatting of a document.<br />Commit Internal Training Session- Course code CMTED -003<br />2<br />
  3. 3. Commit Internal Training Session- Course code CMTED -003<br />3<br />
  4. 4. Why Style Guides?<br />Time Saving<br />Cost Saving<br />Consistency<br />Professionalism<br />Commit Internal Training Session- Course code CMTED -003<br />4<br />
  5. 5. Topics in MSTP<br />Document user interface<br />Content Formatting and Layout<br />Global Content<br />Content for Software Developers<br />Web Content<br />Indexing and Attributing<br />Tone and Rhetoric<br />Commit Internal Training Session- Course code CMTED -003<br />5<br />
  6. 6. Document user interface<br />Screen Terminology<br />Dialog Boxes and Property Sheets<br />Menus and Commands<br />Mouse Terminology<br />Messages<br />Key Names<br />Command Syntax<br />Commit Internal Training Session- Course code CMTED -003<br />6<br />
  7. 7. Commit Internal Training Session- Course code CMTED -003<br />Icon<br />Open window<br />Start menu<br />Start menu<br />Desktop<br />Notification area<br />Taskbar<br />Quick Launch bar<br />7<br />
  8. 8. Commit Internal Training Session- Course code CMTED -003<br />8<br />Dialog Box<br />Properties Sheet<br />
  9. 9. Commit Internal Training Session- Course code CMTED -003<br />9<br />Menus and Commands<br />
  10. 10. Dialog Boxes And Property Sheets<br />Commit Internal Training Session- Course code CMTED -003<br />10<br />Square box that is selected or cleared to turn on or off an option. More than one check box can be selected.<br />Check box<br />Text box with a list box attached. The list is always visible. Because users can either type or select their choice, you can use enter<br />to describe the action. Follow your project style sheet.<br />Combo box<br />Rectangular button that initiates an action. A command button label ending with ellipses indicates that another dialog<br />box will appear: More information is needed before<br />the action can be completed.<br />Command button<br />
  11. 11. Dialog Boxes And Property Sheets<br />Commit Internal Training Session- Course code CMTED -003<br />11<br />Arrow associated with a drop-down combo or list box or some toolbar buttons, indicating a list the user can view by clicking the arrow.<br />Drop-down arrow<br />Closed version of a combo box with an arrow next to it. Clicking the arrow opens the list.<br />Drop-down combo box<br />Closed version of a list box with an arrow next to it. Clicking the arrow opens the list. Depending on the type of list, use either list or box, whichever is<br />Clearer.<br />Drop-down list box<br />
  12. 12. Dialog Boxes And Property Sheets<br />Commit Internal Training Session- Course code CMTED -003<br />12<br />Frame or box that encloses a set of related options. In Windows XP, a group box can be indicated by a single line that unifies the options below it. The group box is a visual device only.<br />Group box<br />Label <br />(do not use caption)<br />Text attached to any option, box,<br />command, and so On.<br />Any type of box containing a list of items the user can select. The user cannot type a selection in a list box.<br />List box<br />
  13. 13. Dialog Boxes And Property Sheets<br />Commit Internal Training Session- Course code CMTED -003<br />13<br />Round button used to select one<br />of a group of mutually exclusive options.<br />Option button<br />(avoid radio button)<br />Indicator on a gauge that displays<br />and sets a value from a continuous range, such as speed, brightness, or volume.<br />Slider<br />Text box with up and down arrows that the user clicks to move through a set of fixed values. The user can also type a valid value in the box.<br />Spin box<br />
  14. 14. Dialog Boxes And Property Sheets<br />Commit Internal Training Session- Course code CMTED -003<br />14<br />Tab<br />On the Tools menu, click Options, and then click the View tab.<br />Title of the dialog box. It usually, but<br />not always, matches the title of<br />the command name.<br />Text box<br />Command button with two “greater<br />than” signs (>>) that enlarges a secondary window to reveal more options or information.<br />Unfold button<br />If you refer to unnamed buttons that appear in the interface, use<br />the syntax as <br />Unnamed buttons<br />
  15. 15. Menus and Commands<br />Commit Internal Training Session- Course code CMTED -003<br />15<br />Menus contain commands. Dialog boxes contain command buttons and options. Do not refer to a command as a menu item.<br />Users click menu items. If you must refer to the user action of opening a menu, use click.<br />Example - <br />On the File menu, click Open.<br />On the View menu, point to Toolbars, and then click Formatting.<br />Refer to unavailable commands and options as unavailable, not as dimmed, disabled, or greyed. <br />Example -<br />There are several unavailable commands on the Edit menu.<br />
  16. 16. Commit Internal Training Session- Course code CMTED -003<br />16<br />Mouse Terminology<br />Do not use cursor or mouse cursor to refer to the pointer. <br />Use pointer or mouse pointer instead.<br />Use click, not click on.<br />Example -<br />Using the mouse, click the Minimize button.<br />However use in to refer to clicking in a general area within a window or dialog box, <br />not click the window or click the Styles box.<br />Example –<br />Click in the window to make it active.<br />Use drag, not click and drag <br />Use drag, not drag and drop<br />Always hyphenate double-click and right-click as verbs<br />
  17. 17. Commit Internal Training Session- Course code CMTED -003<br />17<br />Messages<br />• Avoid vague wording, eg: unexpected error.<br />• Avoid “please.” It can be interpreted to mean that a required action is optional.<br />• Avoid uppercase text and exclamation points.<br />
  18. 18. Commit Internal Training Session- Course code CMTED -003<br />18<br />Command Syntax<br />
  19. 19. Content Formatting and Layout<br />Art, Captions, and Callouts<br />Cross References<br />Heading and Subheadings<br />Line Breaks<br />Page Breaks<br />Tables<br />Notes and Tips<br />Commit Internal Training Session- Course code CMTED -003<br />19<br />
  20. 20. Global Art<br />Commit Internal Training Session- Course code CMTED -003<br />20<br />I am an African equids best known for my distinctive stripes. My stripes come in different patterns unique to each individual. We are generally social animals who live in small harems to large herds. I am a close relative to donkey.<br />
  21. 21. Cross Reference<br />Try to write and edit so that you use cross-references only for material that is not essential to the task at hand. For example, users should not have to look up material to complete a procedure. <br />Commit Internal Training Session- Course code CMTED -003<br />21<br />
  22. 22. Document Conventions<br />Consistent text formatting helps users locate and<br /> interpret information easily. <br />Commit Internal Training Session- Course code CMTED -003<br />22<br />
  23. 23. Headings and Subheadings<br />Commit Internal Training Session- Course code CMTED -003<br />23<br />Heading style varies among groups. The guidelines in this section are widely used and can make it easier to share files across groups. If your group follows a different practice, however, use your group’s style consistently.<br />Group C<br />Getting Started with Visio<br />Group B<br />About Visio<br />Group A<br />Introduction to Visio<br />
  24. 24. Line Breaks<br />Commit Internal Training Session- Course code CMTED -003<br />24<br />Avoid very short lines that leaves large amounts of white space at the end of a line.<br />Do not break a word if it leaves a single letter at the end of the line.<br />Do not break a word if it leaves fewer than three letters at the beginning of the next line.<br />Do not end a page with the first part of a hyphenated word.<br />Do not hyphenate the product names.<br />Try to keep the heading in one line.<br />avoid breaking function names and parameters.<br />
  25. 25. Lists<br />Depending on the type of material that you have to present, you can choose among several types of lists: bulleted, numbered, unnumbered single-column, unnumbered multicolumn, or a “term list.”<br />Commit Internal Training Session- Course code CMTED -003<br />25<br />To log on to a database<br />1. On the File menu, click Open Database.<br />2. In User Name, type your name.<br />3. In Password, type your password, and then click OK.<br />• Reports<br />• Forms<br />• Tables<br />• Modules<br />• Reports,<br />• Forms,<br />• Tables, and<br />• Modules.<br />
  26. 26. Page Breaks<br />Leave at least two lines of a paragraph at the bottom or top of a page. Do not break a word over a page.<br />Avoid separating notes, tips, important notes, cautions, and warnings from the material that they concern.<br />Try to have at least five or six lines on the last page of a chapter.<br />Commit Internal Training Session- Course code CMTED -003<br />26<br />
  27. 27. Tables <br />Place information that identifies the contents of a row in the leftmost column of the table.<br />Make entries in a table parallel—for example, in a description column, be consistent in your use of beginning the entries with a verb or noun.<br />Do not leave a blank column entry. That is, if the information doesn’t apply, use Not applicable or None. <br />Avoid dividing a table between pages.<br />Commit Internal Training Session- Course code CMTED -003<br />27<br />
  28. 28. Notes and Tips<br />Cautions<br />A caution is a type of note that advises users that failure to take or avoid a specified action could result in loss of data.<br />Important notes <br />Positive information that emphasizes or supplements important points of the main text.<br />Tips <br />A tip is a type of note that helps users apply the techniques and procedures described in the text to their specific needs.<br />Warnings<br />A warning is a type of note that advises users that failure to take or avoid a specific action could result in physical harm to the user or the hardware.<br />Commit Internal Training Session- Course code CMTED -003<br />28<br />
  29. 29. Global Content<br />Word Choice<br />Foreign Words and Phrases<br />Time and Place<br />Fonts<br />Commit Internal Training Session- Course code CMTED -003<br />29<br />
  30. 30. Word Choice<br />Commit Internal Training Session- Course code CMTED -003<br />30<br /><ul><li>Always use the simplest and most specific word possible.
  31. 31. Avoid surprising or humorous word choices, slang, and sarcasm.
  32. 32. Spell out geographical names, abbreviations are often ambiguous.
  33. 33. For example CST is always not ChhatrapatiShivaji Terminal
  34. 34. Follow the rules of capitalization for standard written English..Noun vs Proper Noun.</li></li></ul><li>Word Choice<br />Avoid Use instead<br />Master/Slave master subordinate<br />Hang stop responding<br />Behaving unexpected results<br />Bias free communication<br />Chairman Chairperson<br />Manpower Workforce<br />Salesmen Sales representative<br />Commit Internal Training Session- Course code CMTED -003<br />31<br />
  35. 35. Foreign Words and Phrases<br />Avoid non-English words and phrases, such as de facto or ad hoc, even if you think they are generally known and understood. They may not be, or the language may not be understood by a translator. Find a straightforward substitute in English instead.<br />Commit Internal Training Session- Course code CMTED -003<br />32<br />Use these terms Instead of<br />for example e.g.<br />that is i.e.<br />namely viz.<br />therefore ergo<br />
  36. 36. Time and Place<br />To globalize time information, follow these guidelines:<br /> Avoid A.M. and P.M. notation. Use 24-hour time format<br />Begin calendar weeks on Monday<br />Spell out the names of months, use the format month dd, yyyy<br />Do not use numbers to represent months, such as 7/05/2011<br />Avoid referring to seasons<br />Commit Internal Training Session- Course code CMTED -003<br />33<br />
  37. 37. Fonts<br />Use fonts that are available in browsers and operating systems worldwide. Common fonts are <br />Times New Roman <br />Arial <br />Courier New <br />Verdana <br />Commit Internal Training Session- Course code CMTED -003<br />34<br />
  38. 38. Tone and Rhetoric<br />Parallelism<br />Anthropomorphism<br />Humor<br />Commit Internal Training Session- Course code CMTED -003<br />35<br />
  39. 39. Parallelism<br />Parallelism ensures that elements of sentences that are similar in purpose are also similar in structure. <br />Use the Search command on the Start menu to locate the document and then open it.<br />The Search command on the Start menu locates the document, and you can then open it.<br />Double-clicking a document icon in My Computer opens a document.<br />Double-click a document icon in My Computer<br />Commit Internal Training Session- Course code CMTED -003<br />36<br />
  40. 40. Anthropomorphism and Humor<br />Anthropomorphism is attributing human characteristics or behaviour to things that are not human. In technical writing, there is an understandable temptation to anthropomorphize to make difficult material easier for the reader to relate to. Do not succumb to this temptation.<br />Correct<br /> If you receive a confirmation message, the engine will<br /> store your data in the specified format.<br />Incorrect<br /> If you receive a confirmation message, the engine will <br /> behave as you requested.<br />Commit Internal Training Session- Course code CMTED -003<br />37<br />
  41. 41. End of Session…….<br />Commit Internal Training Session- Course code CMTED -003<br />38<br />

×