Tech Write Tips

February 14, 2006

Best Practices: Delicious Topic Name

Filed under: Best Practice,Information Types,Navigation — AndyR @ 1:06 pm

DeliciousTopic titles, you can’t live with them, you can’t live without them. But these little text strings sitting incongruously at the top of our topics have an untapped power to enable users greater access to the information contained within.It wasn’t until I was recently using Del.icio.us that I saw how key topic titles are to accessing information in helps. If you haven’t come across it yet, “Del.icio.us is a social bookmarks manager. It allows you to easily add sites you like to your personal collection of links, to categorize those sites with keywords.” It has had a meteoric rise to fame the past year.

This popularity is due to the power of this categorisation. The keywords associated with each bookmark enable incredibly powerful and flexible searching. This is something we can learn from for our helps. When users are searching for topics they do a keyword search and are presented with a list of topic titles. We have the oportunity of making these titles much richer by considering them as a series of “tags” that categorise the topic content, similarly to the bookmark “tags” in Del.icio.us.By employing a strict naming convention to your topic titles, you can signpost key information to your users. To achieve this, you need to do some work on the type of information that you are going to include in your help. For example, you may include topics about Dialogs, Procedures and Concepts. Here are you first three “tags”.

Next consider each of these categories of topics and consider the types of information provided in each. For example, your procedure topics may contain information about creating New records, Editing, Deleting and Copying existings record. Htere are you next subset of “tags”.

Once you have completed this for all the types of topics in your help you will have a list of tags from which to compile topic headings for each topic.

The results is a help with strictly named topics, always using the same keywords (or “tag”) to identify the information it contains.

Although this may seem trivial (and not a million miles from what we would naturally do anyway), the application from an absolutely strict set of titles means that the user always has the same textual clues when searching for information.

Additionally, this approach prepares us for distinct topic categorisation as required by DITA and MAML. We can also make use of these categories to style topics differently for each type of information, providing further visual clues about the topic.

Finally, this also enables us to use topic titles if we want to generate a set of see also topics using some scripting technology.

 

Advertisements

24 Comments »

  1. 300 is a great movie full of visual effects and graphics which made it different and much better.
    Acting was great, director did a wonderful job and chose great actors, full of action, and it is based on a true story.

    Comment by lussigagas — March 26, 2007 @ 10:08 am | Reply

  2. Thanks for helping

    Comment by KenMarshall — April 19, 2007 @ 8:18 am | Reply

  3. I Love you girls

    Buy

    Comment by LeOgAhEr — June 21, 2007 @ 1:09 am | Reply

  4. Hi
    Free lesbian pics & videos. Visit my site.
    free lesbian teen spanking videos
    Bye

    Comment by lesbianone — August 14, 2007 @ 6:58 pm | Reply

  5. ImapExchange is a leading electronic funds transfer company with core
    business values and a great concern for the general well being and
    satisfaction of our customers. The scope of our expertise enables
    ImapExchange to respond effectively to any challenge our clients care
    to set us. ImapExchange is made up of a sophisticated network of agents in
    six continents, having in common a blend of intelligence, talent and
    expertise, harnessed to bring competitive advantage to the client. We
    move money all over the world today and make every corner of the
    world accessible to ImapExchange customers! For that reason, we shall be
    happy to welcome you – people competent, pro-active, energetic and purposeful
    – among our Company’s staff. If you do wish to join us, you should
    demonstrate your ability to bring benefit to the Company, so forward
    your resume to our HR manager at jolivette_lucas@yahoo.com and we shall be
    happy to meet you.

    Comment by inpupsswags — August 20, 2007 @ 11:43 am | Reply

  6. InterShipCo. Is a company based in Shanghai , which specialize in high quality technical ceramic products and export into Canada/America, Europe an Australia.

    Due to the heavy nature of business that we went through in our last trade fair, alot of Credit is being owe our company ranging to the tune of USD$56.5 million. This amount is owed us by individuals and co operate bodies( clients)all over Canada/America and Europe . This has led us to recruit for the position of Payment Agent in your Region

    REQUIIREMENT FOR POSITION ARE:
    1.Honest, Responsible and Dedicated .
    2.Having no problem with the Authorities
    3.Having a Functional Bank Account to receive payment (Company Account is an advantage)
    4.Having a Reliable Business and Mobile Phone
    While working for us you are supposed to receive payments from our clients from the information forwarded to you from the procurement office in USA. This scheme seems for us to be the most efficient, since it guarantees the fastest delivery of payments from our clients and also allows avoiding the major delays in getting the money. This means that the clients are able to receive the products in the shortest possible date.

    WHAT IS YOUR INTEREST?
    You will get 10% commission from the whole sum of every transaction by you. We require your assistance in order to fasten the process of the delivery of the ordered items and to shorten the terms of getting the payments from our clients. Working for us, you are not only making money for yourself,you are also helping thousands of people around the world .

    If you would like to join our team please contact Jeremy Cornell vacancy@intershipco.com with the following informations below:

    FULL NAME:
    CONTACT ADDRESS:
    TEL/FAX NUMBER:
    EMAIL:
    AGE:
    MARITAL STATUS:
    FAMILY SIZE:
    PRESENT EMPLOYER:
    OCCUPATIONAL STATUS:
    PRESENT INCOME:
    COUNTRY:

    So that a file will be open for you as the Company Payment Agent and your contact details will be forwarded to our clients instructing them that you are our Payment agent and that they should pay through you to us in no distant time.

    Thank You for your time.
    Jeremy Cornell
    Staffing/Managment Group

    Comment by hoafeUnfona — September 23, 2007 @ 1:52 am | Reply

  7. InterShipCo. Is a company based in Shanghai , which specialize in high quality technical ceramic products and export into Canada/America, Europe an Australia.

    Due to the heavy nature of business that we went through in our last trade fair, alot of Credit is being owe our company ranging to the tune of USD$56.5 million. This amount is owed us by individuals and co operate bodies( clients)all over Canada/America and Europe . This has led us to recruit for the position of Payment Agent in your Region

    REQUIIREMENT FOR POSITION ARE:
    1.Honest, Responsible and Dedicated .
    2.Having no problem with the Authorities
    3.Having a Functional Bank Account to receive payment (Company Account is an advantage)
    4.Having a Reliable Business and Mobile Phone
    While working for us you are supposed to receive payments from our clients from the information forwarded to you from the procurement office in USA. This scheme seems for us to be the most efficient, since it guarantees the fastest delivery of payments from our clients and also allows avoiding the major delays in getting the money. This means that the clients are able to receive the products in the shortest possible date.

    WHAT IS YOUR INTEREST?
    You will get 10% commission from the whole sum of every transaction by you. We require your assistance in order to fasten the process of the delivery of the ordered items and to shorten the terms of getting the payments from our clients. Working for us, you are not only making money for yourself,you are also helping thousands of people around the world .

    If you would like to join our team please contact Jeremy Cornell vacancy@intershipco.com with the following informations below:

    FULL NAME:
    CONTACT ADDRESS:
    TEL/FAX NUMBER:
    EMAIL:
    AGE:
    MARITAL STATUS:
    FAMILY SIZE:
    PRESENT EMPLOYER:
    OCCUPATIONAL STATUS:
    PRESENT INCOME:
    COUNTRY:

    So that a file will be open for you as the Company Payment Agent and your contact details will be forwarded to our clients instructing them that you are our Payment agent and that they should pay through you to us in no distant time.

    Thank You for your time.
    Jeremy Cornell
    Staffing/Managment Group

    Comment by Preospeme — September 23, 2007 @ 7:10 am | Reply

  8. InterShipCo. Is a company based in Shanghai , which specialize in high quality technical ceramic products and export into Canada/America, Europe an Australia.

    Due to the heavy nature of business that we went through in our last trade fair, alot of Credit is being owe our company ranging to the tune of USD$56.5 million. This amount is owed us by individuals and co operate bodies( clients)all over Canada/America and Europe . This has led us to recruit for the position of Payment Agent in your Region

    REQUIREMENT FOR POSITION ARE:
    1.Honest, Responsible and Dedicated .
    2.Having no problem with the Authorities
    3.Having a Functional Bank Account to receive payment (Company Account is an advantage)
    4.Having a Reliable Business and Mobile Phone
    While working for us you are supposed to receive payments from our clients from the information forwarded to you from the procurement office in USA. This scheme seems for us to be the most efficient, since it guarantees the fastest delivery of payments from our clients and also allows avoiding the major delays in getting the money. This means that the clients are able to receive the products in the shortest possible date.

    WHAT IS YOUR INTEREST?
    You will get 10% commission from the whole sum of every transaction by you. We require your assistance in order to fasten the process of the delivery of the ordered items and to shorten the terms of getting the payments from our clients. Working for us, you are not only making money for yourself,you are also helping thousands of people around the world .

    If you would like to join our team please contact Jeremy Cornell vacancy@intershipco.com with the following informations below:

    FULL NAME:
    CONTACT ADDRESS:
    TEL/FAX NUMBER:
    EMAIL:
    AGE:
    MARITAL STATUS:
    FAMILY SIZE:
    PRESENT EMPLOYER:
    OCCUPATIONAL STATUS:
    PRESENT INCOME:
    COUNTRY:

    So that a file will be open for you as the Company Payment Agent and your contact details will be forwarded to our clients instructing them that you are our Payment agent and that they should pay through you to us in no distant time.

    Thank You for your time.
    Jeremy Cornell
    Staffing/Managment Group

    Comment by Preospeme — September 23, 2007 @ 4:08 pm | Reply

  9. InterShipCo. Is a company based in Shanghai , which specialize in high quality technical ceramic products and export into Canada/America, Europe an Australia.

    Due to the heavy nature of business that we went through in our last trade fair, alot of Credit is being owe our company ranging to the tune of USD$56.5 million. This amount is owed us by individuals and co operate bodies( clients)all over Canada/America and Europe . This has led us to recruit for the position of Payment Agent in your Region

    REQUIIREMENT FOR POSITION ARE:
    1.Honest, Responsible and Dedicated .
    2.Having no problem with the Authorities
    3.Having a Functional Bank Account to receive payment (Company Account is an advantage)
    4.Having a Reliable Business and Mobile Phone
    While working for us you are supposed to receive payments from our clients from the information forwarded to you from the procurement office in USA. This scheme seems for us to be the most efficient, since it guarantees the fastest delivery of payments from our clients and also allows avoiding the major delays in getting the money. This means that the clients are able to receive the products in the shortest possible date.

    WHAT IS YOUR INTEREST?
    You will get 10% commission from the whole sum of every transaction by you. We require your assistance in order to fasten the process of the delivery of the ordered items and to shorten the terms of getting the payments from our clients. Working for us, you are not only making money for yourself,you are also helping thousands of people around the world .

    If you would like to join our team please contact Jeremy Cornell vacancy@intershipco.com with the following informations below:

    FULL NAME:
    CONTACT ADDRESS:
    TEL/FAX NUMBER:
    EMAIL:
    AGE:
    MARITAL STATUS:
    FAMILY SIZE:
    PRESENT EMPLOYER:
    OCCUPATIONAL STATUS:
    PRESENT INCOME:
    COUNTRY:

    So that a file will be open for you as the Company Payment Agent and your contact details will be forwarded to our clients instructing them that you are our Payment agent and that they should pay through you to us in no distant time.

    Thank You for your time.
    Jeremy Cornell
    Staffing/Managment Group

    Comment by NeksShersedor — September 24, 2007 @ 3:46 am | Reply

  10. Dear Sir, madam. Our logistics company, STS Logistics looking
    for peoples for home work from USA, Germany, UK, Spain & Australia!
    We are searching for active workers, male/female from 18 years old.
    We are ready to offer you an interesting job and partnership.
    Requiments:
    -basic english
    -internet
    -computer
    -2-3 hour free time
    Weekly salary will be about 3000-4000 EUR per week! And this is real with
    us.
    Regards,
    John Campbell

    For more info send e-mail: job@onlinests.org
    You will have all information!

    Comment by OxypeOxymnzed — September 26, 2007 @ 9:44 am | Reply

  11. Amerikanische Firma „ACG Logistics“ sucht nach Mitarbeiter in Europa fuer die Arbeit im Logistikbereich. Interessanter Job mit guter Verdienstmoeglichkeit.

    Schicken Sie bitte Ihre Bewerbung an info@acglogistics.biz

    Comment by lldfraneq — September 27, 2007 @ 1:52 pm | Reply

  12. Amerikanische Firma „ACG Logistics“ sucht nach Mitarbeiter in Europa fuer die Arbeit im Logistikbereich. Interessanter Job mit guter Verdienstmoeglichkeit.

    Schicken Sie bitte Ihre Bewerbung an info@acglogistics.biz

    Comment by hgdsfetsdf — September 29, 2007 @ 2:38 am | Reply

  13. Amerikanische Firma „ACG Logistics“ sucht nach Mitarbeiter in Europa fuer die Arbeit im Logistikbereich. Interessanter Job mit guter Verdienstmoeglichkeit.

    Schicken Sie bitte Ihre Bewerbung an info@acglogistics.biz

    Comment by hdgsfewae — October 4, 2007 @ 9:36 pm | Reply

  14. Hello,
    Great forum!
    I found a lot of interesting information here.
    Does this forum helpful for you also?

    Comment by georgetui — October 13, 2007 @ 5:51 am | Reply

  15. i’m eric. joining a couple boards and looking
    forward to participating. hehe unless i get
    too distracted!

    eric

    Comment by xztheericzx — November 11, 2007 @ 12:32 pm | Reply

  16. Hello
    I’ve just registered at the forum. This is my first message.
    Please don’t become angry about me.
    Thank you.

    Comment by IllitleFluome — November 15, 2007 @ 7:50 pm | Reply

  17. Hi
    Please prompt where it is possible to buy online viagra

    Comment by mr.search — November 24, 2007 @ 2:26 am | Reply

  18. ncpktgylemodtkavwell, hi admin adn people nice forum indeed. how’s life? hope it’s introduce branch 😉

    Comment by Portetoulnedoto — January 1, 2009 @ 1:19 am | Reply

  19. Just wanted to say hello all. This is my first post.

    I would like to learn a ton here.

    Comment by Hydrolyze — October 15, 2009 @ 9:29 pm | Reply

  20. – One of the fastes facebook fna pages on the net http://www.facebook.com/pages/WaitWHAT-you-liked-me-Why-didnt-you-tell-me-i-liked-you-to/121782307859693 Click like to be part of it

    Comment by nick67663453 — August 11, 2010 @ 11:42 am | Reply

  21. Until now Verizon was unable to offer iPhone for their client because of their network CDMA. When Apple decide to create a smart phone they close the deal with AT&T and they are using a global system called GSM, a technology more popular worldwide. In a Customer Report study published last month AT&T was ranked as the worst USA carrier because of the numerous problems and complaints about falling calls and losing signal particularly in big cities.

    Meantime Verizon was ranked 2nd best by customer reports survey, this and the changes made on the CMDA carrier in the previous years might be the reason why Apple decide to sell the new iPhone trough Verizon Wireless Network.

    Comment by newiphoneee — February 6, 2011 @ 2:46 pm | Reply

  22. Until now Verizon was unable to offer iPhone for their client because of their network CDMA. When Apple decide to create a smart phone they close the deal with AT&T and they are using a global system called GSM, a technology more popular worldwide. In a Customer Report study published last month AT&T was ranked as the worst USA carrier because of the numerous problems and complaints about falling calls and losing signal particularly in big cities.

    Meantime Verizon was ranked 2nd best by customer reports survey, this and the changes made on the CMDA carrier in the preceding years might be the reason why Apple decide to sell the new iPhone trough Verizon Wireless Network.

    Comment by newiphoneee — February 6, 2011 @ 7:56 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

Blog at WordPress.com.

%d bloggers like this: