Skip to main content

Language for technical courses

The language for technical courses should be fairly simple, straightforward and formal, as the content is most often action or task oriented. A few general guidelines to write for such content are:
  1. Don't use irrelevant jargon to decorate your conversation. Doing such things will not help engage the learner, but distract his focus from the objective. Instead use short but relevant scenarios and examples that help the learner relate to their job. Relevance is a great attention grabber. For example: As an administrator, you are required to assign permissions to various users based on their job roles. Look up the master list of users, and assign the users to their roles using the User Administration tab.
  2. Always start the instruction step of a procedure giving the location of the object on which an action needs to be performed. For example: In the Volume Control dialog box, select the Advanced button.
  3. Always give the result of the action at the end of the step soon after the instruction. For example the result of Step 2 would be, The Advanced Controls for Volume Control dialog box opens.
  4. Use third person when it comes to technical documentation, but you could selectively use the second person. When it comes to online courses, try and keep a conversational undertone with a conscious effort to keep the seriousness of the topic. This would change if you are creating a story based learning course built around a real time scenario.
  5. Follow your style guide, but keep in mind that when you write for online learning you need to bring emphasis to certain words using styles. Certain times style guides do not address the needs of online learning courses. For example: In the Volume Control dialog box, select the Advanced button.
  6. Avoid using pronouns often in sentences when you are trying to indicate an action. For example: The sentence, Look up the master list of users, and assign them to their roles using the User Administration tab, is confusing over, Look up the master list of users, and assign the users to their roles using the User Administration tab.
  7. Use contractions where they help make your sentences more concise, as unnecessarily long sentences can also be distracting.
  8. Avoid using the gerund form of verbs unless absolutely necessary. For example: Use Run the setup file over Running the setup file.
Always keep these guidelines in mind without forgetting that you don't want to sound like a robot and you need to do everything that will help your audience learn complex technical topics better .

Comments

Popular posts from this blog

Of Android, Mobile Games and Learning Experiences

I never thought I'll write about learning games and mobile learning until I bought my Android. People have asked me, why Android phone? My answer has been that I love Android as it is breaking new ground for mobile computing and open technologies. Android is versatile as it is not limited only to mobile phones, but it can be installed on various devices. Android gives developers the opportunity to leverage their development skills, while also building an exciting and active community, just as ground breaking as Java. Just thought of adding this: "When technologies don't restrain you, they enable you to innovate." I truly believe open technologies are the future! I couldn't have written this post without experiencing the real thing. I had set aside to buy my Android (Nexus S) after some expenses were out of the way. But my 5 year old Nokia gave in and I had no other choice but to buy my Nexus immediately. I am extremely happy. Having the power of a smartphone ,...

Future of Organizational Learning: Some questions

Recently, someone from Bloomfire contacted me over LinkedIn and requested me to give answers to some questions. I have been late to respond but thought they were pertinent given the way things have changed in the training world. So let me answer them for myself anyway before I send them to Bloomfire. From your perspective, what are some of the challenges in writing curricula that resonate with the learner? The main challenge I see is Knowing your audience precisely. Knowing your audience helps you scope out the training accurately and achieve the right level of detail. It will be the key to any kind of task you want to do; build a product, create a game, or plan training content. How might these challenges differ from the challenges of yesterday? I believe the challenges of yesterday were more than the challenges of today. The intervention of Web 2.0 and the increasing tech-savvyness of the learner have made information immediately accessible to one and all. Today, most informatio...

Big Question: OMG I'm Stuck!!

This months Big Question is about Stuck?Getting Unstuck? Stuck, is exactly how I feel, and the reason I started blogging and connecting with people. My blog becomes a forum to get my ideas out. So there's the problem and the solution right there! But come on now, don't we all feel stuck at different points in our work or even personal life? Well, being stuck is very much a reality as anything else, and I've felt this way many times before. Each place I worked posed different kinds of challenges, but to get to the point, here we're talking about being stuck in your organization with a lot of great ideas about how to improve things around you and the service you deliver to the customer. There are several reasons why one gets 'stuck' so to say: Your organization is just very happy doing what they always have been doing as it earns them money anyway. Your team members, who drive a lot of the initiatives because they've been around longer than you, just don'...