Basic guidelines to writing technical documentation

[:en]Writing technical documentation should not be a complicated procedure. Remember, you’re not writing a novel. You want to communicate information and procedures in a clear and concise fashion. Sometimes basic short sentences and bullet points are the best means to get your point across. It’s also important to make sure that you stay on topic. It can be very easy to add too many examples or letting related issues take over your documentation. If there are important issues that are directly related to your subject, address them in another document and reference them but keep your topics as separate as possible.

Below are some basic guidelines for writing good technical documentation.

1. Use Bullet point form.
2. Keep sentence structure short and simple.
3. Add some screen shots if need be. (Sometimes the best explanations are the visual explanations)
4. Highlight or BOLD important words or sections.
5. Structure the documentation with indented and numbered sections that can be referenced throughout the document.
6. Keep your technical documentation as short and concise as possible.

In my experience, I have always followed these basic steps and have achieved good and positive results when writing technical documentation. In today’s fast-paced life, sometimes just a few words can save hours of headaches.[:fr]Writing technical documentation should not be a complicated procedure. Remember, you’re not writing a novel. You want to communicate information and procedures in a clear and concise fashion.  Sometimes basic short sentences and bullet points are the best means to get your point across.  It’s also important to make sure that you stay on topic.  It can be very easy to add too many examples or letting related issues take over your documentation. If there are important issues that are directly related to your subject, address them in another document and reference them but keep your topics as separate as possible.

Below are some basic guidelines for writing good technical documentation.

1. Use Bullet point form.
2. Keep sentence structure short and simple.
3. Add some screen shots if need be. (Sometimes the best explanations are the visual explanations)
4. Highlight or BOLD important words or sections.
5. Structure the documentation with indented and numbered sections that can be referenced throughout the document.
6. Keep your technical documentation as short and concise as possible.

In my experience, I have always followed these basic steps and have achieved good and positive results when writing technical documentation.  In today’s fast-paced life, sometimes just a few words can save hours of headaches.[:]