Showing posts with label documentation. Show all posts
Showing posts with label documentation. Show all posts

Thursday, September 20, 2012

Editing


What is editing?

Editing is improving the quality of the content produced by an author or individual by adhering to the following:

  • Clear
  • Consice
  • Correct
  • Complete
  • Consistent

Why is editing required?

Writers are humans and can miss the "obvious" spellings and other rules. The editors may detect the missed errors, thus ensuring conformance to the standards.

Writers, peers or designated editors can edit the content of a document.

The aspects of editing

The following aspects can be considered:

  1. Language - which includes spelling, grammar, punctuation, parallelism and symbols, word usage and terminology
  2. Organization - Trademark acknowledgements, legal and safety statements, regulations, standards and style guidelines and integrity (title, headers and footers)
  3. Reader - Safety and usability, readability and navigation, structure of information, and ambuguity
  4. Author - Respect for the content and schedule (to avoid last minute updates), sensitivity in providing the comments

Tuesday, March 13, 2012

Process

In general, process can be defined as a sequence of interdependent and/or dependent procedures, which at every stage, consume one or more resources (employee, time, money, etc.) to convert input into output. These output can be served as input to the next stage until the goals are achieved.

In simpler terms, process is a series of actions, changes or functions that bring about a known result or goal.

The process established in each company varies, depending on the requirements and available resources. But, in general the technical publications has a process set up, which must be adhered to by the team. The process overview diagram is shown below.

Friday, February 17, 2012

What is technical writing?


Technical writing is probably the most widely read form of written communication around, with the exception of advertising. It is a craft that aims to provide technical, business or educational information in a clear and concise manner. 


Technical writing in business can include training manuals, employee guidelines or handbooks and other specialized writing that is task specific.


Technical writing is arguably more difficult than other forms of writing because of the fact that it must be clear and to the point. Good technical writing should not leave any room for imagination and it must anticipate and answer any questions or problems that may arise. This aspect of technical writing is often seen in ‘frequently asked questions’ and ‘trouble shooting’.


The demand for technical writers is high, which makes a career in technical writing a great option for many writers or others who have great organizational, grammar and communication skills. Technical writing provides a decent salary and is often available to freelancers as well as onsite employees. There are many training programs available for people who wish to enter the field of technical writing.