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

Big Question: Workplace Learning in 10 Years?

This month's Big Question question is Workplace Learning in 10 years? A very pertinent question to ask in such times, as we hear of more and more failure rates in formal and push learning. Most of our generation have learned this way, and some like me have always found such learning boring from the very beginning. My parents, would force me to learn the way the other 'good' kids learned, and I would resist and prefer to stay in my own dreamworld, that I found more fascinating than my study books. Fortunately for me, every year before the final exam my mom would hound me into preparing for the exams and I would come out scoring reasonably well. Now I can owe my 'decent' job to all the 'push' I got from my parents. But given a chance, I would not like to go back to studying the way I did in school, though I owe my 'formal' degrees to the 'formal' learning I received. But I did have some pretty good teachers. My Geography teacher had a unique s

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 ,

The New Age Instructional Designer

Instructional design provides a gamut of principles and models that enable you to train people effectively in various areas of expertise. The role of an instructional designer is essentially driven by a need to find appropriate solutions by applying instructional design strategies and models to transfer information to users who use a particular product or service to perform their jobs. Changed Learning Methods As time progressed and technologies evolved, the role of the instructional designer as we understood it several years back, underwent a paradigm shift. In spite of client demands to create conventional elearning courses, the fact is that the way people are learning today has changed phenomenally due to the increased access to social media tools and advanced mobile devices. Twitter, blogs, wikis, and discussions have become the new age learning methods. Learner's look for relevance and access information only when it is needed. The concept of reading everything that co