Technical Documentation in Pharma & Healthcare

Which are this Documents:

1. Pharmaceutical monographs

2. User manuals

3. Package labeling

4. Journal articles

5. Training manuals

6. Technical reports

2

1. P’ceutical Monographs

A monograph includes the • name of the ingredient, molecular formula & structure • preparation; • the definition; • packaging, storage, and labeling requirements; and the

specification. • Identification & Purity tests, procedures for the tests, assay

and acceptance criteria. • These tests and procedures require the use of official USP

Reference Standards.

3

It is all about the first word in the phrase — it is generally about the operation.

This is more general than just using something; it starts with transport and storing, is then followed by installation and commissioning up to using the product, continues with cleaning, service and repair and ends up with dismantling and disposal.

A document describing operating should therefore be correspondingly comprehensive (not forgetting the safety information).

2. USER MANUALS

3. Package labeling

5

A journal (through French from Latin diurnalis, daily)

Many publications issued at stated intervals, such as magazines, or scholarly journals, academic journals, or the record of the transactions of a society, are often called journals.

Although journal is sometimes used as a synonym for "magazine", in academic use, a journal refers to a serious, scholarly publication that is peer-reviewed.

4. journal & article

An article is a particular section or item of a series in a written document, as in a contract, constitution, or treaty.

5. Training Manual

A training manual is a book or booklet of instructions, designed to improve the quality of a performed task. Training manuals are widely used, including in business and the military.

A training manual may be particularly useful as: an introduction to subject matter prior to training an outline to be followed during training a reference to subject matter after training a general reference document

A training manual may form an important part of a formal training programme. For example, it may help ensure consistency in presentation of content. It may also ensure that all training information on skills, processes, and other information necessary to perform tasks is together in one place.

Training manuals can be designed to be used as: Work books – used in training sessions to provide basic information, examples and

exercises. Self-paced guides: designed for trainees to work through on their own. Reference manuals: for containing detailed information on processes and

procedures. Handouts: provide general information to support training done during the session. Job aids: provide step-by-step instructions to be used in the workplace.

A technical report (also: scientific report) is a document that describes the process, progress, or results of technical or scientific research or the state of a technical or scientific research problem.

It might also include recommendations and conclusions of the research.

Unlike other scientific literature, such as scientific journals and the proceedings of some academic conferences, technical reports rarely undergo comprehensive independent peer review before publication.

Where there is a review process, it is often limited to within the originating organization.

Similarly, there are no formal publishing procedures for such reports, except where established locally.

6. Technical report

Schemes of documents:

Must not confuse formal communications in technical documentation.

It is an art to explain technical subjects to both technical and non-technical audiences.

Technical writing is a subset of formal communication that requires in-depth technical knowledge

Requires us to be accurate and precise.

Misinterpretations are possible which would defeat the very purpose of technical writing.

Schemes of documents:

If we are not able to put across the results of our important research or study, due to poor technical report writing skills, it would be a wasted effort.

Thinking first in the mother tongue and then translating it into English can result be a drawback.

1. “Beware of our brand” instead of “Buy only our brand”

2. “A flexible computer” instead of “A versatile computer”

3. “Tender light” instead of “Soft light”

4. “Big Speed” instead of “High speed”

The Importance of Technical Writing:

• To present information comprehensively

• To present information in the appropriate format

• To organize details with conciseness and appropriateness

• To use jargon sparingly and after an audience analysis

• To showcase the industry’s and organization’s 

achievements in the desired light 

• To accurately record the activities of an organization

Techniques for Good Technical Writing:

• Overcoming writer’s block• Add emphasis in writing• Accentuate the positives• Prioritize for effective writing

Prioritize according to deadlines.• Write effectively• Write efficiently

Referencing and styling

Day to day Pharma Examples

The doctor/patient read the manual and follow the steps involved in diabetic footcare

They can keep coming back to it as often as required

Face to Face Medical detailing to doctors    with or without the use of Visual Aids and other 

props

A 2-way conversation instead of a one-way technical monologue is what generates prescriptions

13

Language

14

Appropriateness• Sing suitable level of language familiarity• Avoid deceitful language/euphemisms• Avoid slang• Using apt idiomatic expressions• Using group specific jargon• Avoid biased/stereotypical language

Acceptability • More applicable to legal policies, rules and regulations

Language

15

Conciseness and flow

• Remove redundant

• Reduce clauses to phrases and phrases to single words

• Avoid using words such as really, very, quite, extremely, severely when they

are not necessary.

• Edit out phrases that can be omitted

• Avoid euphemisms

Contd…

Personal problems:

Clarity Choose precise, concrete and familiar words

Economy Avoid wordy sentences

Sentence Variety

One should bring in a variety of sentences:Simple, Compound and Complex in order to hold the readers’ interest. Break longer sentences into shorter ones.

Techniques for Good Technical Writing

• Overcoming writer’s block• Add emphasis in writing• Accentuate the positives• Prioritize for effective writing

Prioritize according to deadlines.• Write effectively• Write efficiently

Referencing and styling

Conclusion:

Documentation is the approval process where an sort technical skills are been made for its utilization.

Its also an evidence proof for the future aspects.

It has became an need of in Pharmacy fraternity.

References http://en.wikipedia.org/wiki/Technical_documentation (Accessed on 12/09/13)

"01.110: Technical product documentation". International Organization for Standardization.

Retrieved 10 June 2009.

"ISO 15787:2001 Technical product documentation -- Heat-treated ferrous parts -- Presentation

and indications". International Organization for Standardization. Retrieved 10 June 2009."ISO

3098-0:1997 Technical product documentation -- Lettering -- Part 0: General

requirements". International Organization for Standardization. Retrieved 10 June 2009.

"ISO 10209-1:1992 Technical product documentation -- Vocabulary -- Part 1: Terms relating to

technical drawings: general and types of drawings". International Organization for

Standardization. Retrieved 10 June 2009.

"ISO 2162-1:1993 Technical product documentation -- Springs -- Part 1: Simplified

representation". International Organization for Standardization. Retrieved 10 June 2009.

"ISO 5457:1999 Technical product documentation -- Sizes and layout of drawing

sheets". International Organization for Standardization. Retrieved 10 June 2009.