Tech Write Tips

February 14, 2006

Best Practices: Write a Dictionary

Filed under: Best Practice — AndyR @ 1:48 pm

dictionary1.gifIt has been said that a dictionary is a:

“malevolent literary device for cramping the growth of a language and making it hard and inelastic. This dictionary, however, is a most useful work.”

This is the crux of the matter. The dictionaries imposed on us can be seen as cramping style and limiting creativty. However, if we use and own our dictionaires, they become tools that frame and enable our highest works of communication. Ownership and use are key, and go hand in hand. This is the basis of today’s best pratice suggestion. Start your own dictionary, make it particular to your work, then get in the habit of using it. I have found the following features useful in our in-house dictionary.

  • Build on existing style manual. We use Microsoft Manual of Style for Technical Publications, it’s not perfect but it gives us a starting point.
  • In your dictionary document it is useful to be able to sort in a variety of ways. We find it particularly useful to order entries by their created date.
  • Ideally your dictionary should be searchable, we do this with some xsl filtering, but as long as your is electroinc is should be pretty straight forward to search.
  • Finally, ensure your dictionary is freely and easily accessible to those who need it.

You should record your dictionary in the medium that best suites your needs. We use an xml file which is then transformed for viewing. This enables it to be viewable in  avariety of formats and quickly ordered or searched as required.

XML File:
<Entry>
 <Date></Date> – Date the netry was added to enable you to highlight new entries.
 <Update></Update> – Updated date to enable you to highlight updates.
 <Category></Category> – Grouping of the type of entry, is it general grammar, procedural or formatting.
 <Item></Item> – Unique reference for the item, usually the word or phrase in question
 <rule></rule> – A description of how the item should be used.
 <Correct></Correct> – An example of how the item should be used in practice.
 <Incorrect></Incorrect> – An example of how the item should not be used in practice.
</Entry>

XSL File:
<xsl:for-each select=”//Entry”>
 <xsl:sort select=”Update” order=”descending”/>
 <B><xsl:value-of select=”Item”/></B> <xsl:value-of select=”Category”/>
 <P><xsl:value-of select=”rule”/></P>
 <UL>
  <xsl:for-each select=”Correct”>
   <LI>Correct: <xsl:value-of select=”../Correct”/> </LI>
  </xsl:for-each>
  <xsl:for-each select=”Incorrect”>
   <LI>Correct: <xsl:value-of select=”../Incorrect”/> </LI>
  </xsl:for-each>
 </UL>
 <P><xsl:value-of select=”Date”/> <xsl:value-of select=”Update”/></P>
</xsl:for-each>

Advertisements

17 Comments »

  1. That’s all well and good but how do I get my authors to use the dictionary? Particularly where they have historically done things differently.

    Comment by dave — February 16, 2006 @ 8:17 am | Reply

  2. MSN I NIIPET
    MSN

    Comment by Bill — May 12, 2007 @ 3:36 pm | Reply

  3. hi,i want to write a dictionary of translation of English to my language(South African language,sepedi).The first step i have done so far is the translation of words but i have not finish with that.The second step that i want to do is to put the words in alphabetical order,since the words are so numerous and writing them in order using hand it will take me a very long time to finish,I like to know if is there any software or electronic device that can facilitate in laying the words in order.

    Comment by Theko — July 21, 2009 @ 12:03 pm | Reply

    • Hello Theko.
      I am a grade 12 student and I have IT at school. Our Practical Assessment Task this year is to create an electronic dictionary. If you send me your Sepedi database with words via email, I can include Sepedi in my program and you will be able to sort your wors alphabetically with my program.
      Regards, Carli.

      Comment by Carli Grobbelaar — February 6, 2011 @ 12:18 pm | Reply

  4. 39Gy1J http://chfEd38MkKsw7cXv0x3Dlc3b7.com

    Comment by jimmy — January 22, 2011 @ 9:02 am | Reply

  5. I’d like a phonecard, please ls magazine news ffi

    Comment by Twcebmbo — September 4, 2011 @ 6:56 pm | Reply

  6. I quite like cooking pink pussy teen girls 418

    Comment by Ivblgpik — September 6, 2011 @ 8:05 am | Reply

  7. Some First Class stamps preteen lolita top
    >:-[[[

    Comment by Knenfsll — September 7, 2011 @ 12:26 am | Reply

  8. About a year Free Lolita Porn ubzn

    Comment by Cszxpbvy — September 20, 2011 @ 3:37 am | Reply

  9. We went to university together Lolita Teen
    543947

    Comment by Pkagbfvc — September 23, 2011 @ 8:58 am | Reply

  10. Sorry, you must have the wrong number 14yo Model Pics
    55672

    Comment by Chlkcvup — September 24, 2011 @ 6:07 pm | Reply

  11. Cool site goodluck 🙂 Redcove Teen Models
    256137

    Comment by Mobjpwnt — September 25, 2011 @ 12:00 am | Reply

  12. Other amount Small Model Airplane
    %((

    Comment by Kqyejxxm — September 25, 2011 @ 2:56 am | Reply

  13. I’m on work experience Greatlolita Bbs
    510784

    Comment by Oyclzjlr — December 7, 2011 @ 10:34 am | Reply

  14. Very funny pictures http://unyqymuetahi.de.tl young littlemodels xxx This girl needs to learn how to work her ass. Amature at best, only reason shes famous cuz its so damn big for a white girl.

    Comment by Sodxdiun — May 3, 2012 @ 2:29 am | Reply

  15. I work for myself http://yorudaaju.de.tl preteens real video WHAT I LIKE SO MUCH ABOUT THIS CHICK SHE CAN DO IT ALL AND DO IT WELL SHE IS JUST AWESOME.

    Comment by Hhwizzmv — May 7, 2012 @ 6:13 am | Reply

  16. how much it cost to write a mini dictionary using english translate to other south African languages,and what easy way to write it and what is a cheapest place to write a dictionary or a book,from jacob at jhb south.help me 0731976645

    Comment by jacob — January 30, 2013 @ 12:28 pm | Reply


RSS feed for comments on this post. TrackBack URI

Leave a Reply

Fill in your details below or click an icon to log in:

WordPress.com Logo

You are commenting using your WordPress.com account. Log Out / Change )

Twitter picture

You are commenting using your Twitter account. Log Out / Change )

Facebook photo

You are commenting using your Facebook account. Log Out / Change )

Google+ photo

You are commenting using your Google+ account. Log Out / Change )

Connecting to %s

Create a free website or blog at WordPress.com.

%d bloggers like this: