The Darwin Information Typing Architecture (DITA)

The Darwin Information Typing Architecture (DITA) is a comprehensive framework for authoring, managing, and distributing topic-oriented information in XML.

First developed by IBM, DITA goes beyond any previous approach in helping organizations overcome barriers to XML adoption, maximize content reuse, and reduce information redundancies.

Today, DITA is a widely supported specification managed by OASIS (Organization for the Advancement of Structured Information Standards), the industry body responsible for many other business-oriented XML standards.

DITA is an architecture for creating topic-oriented, information-typed content that can be reused and single-sourced in a variety of ways. It is also an architecture for creating new information types and describing new information domains based on existing types and domains. This allows groups to create very specific, targeted document type definitions using a process called specialization, while still sharing common output transforms and design rules developed for more general types and domains.

DITA supports a unique transclusion mechanism that is validated under DTD processing rules: an element "can replace itself with the content of a like element elsewhere, either in the current topic or in a separate topic that shares the same content models. DITA's conref 'transclusion' mechanism is similar to the SGML conref mechanism, which uses an empty element as a reference to a complete element elsewhere. However, DITA requires that at least a minimal content model for the referencing element be present, and performs checks during processing to ensure that the replacement element is valid in its new context. This mechanism goes beyond standard XInclude, in that content can be incorporated only when it is equivalent: If there is a mismatch between the reusing and reused element types, the conref is not resolved. It also goes beyond standard entity reuse, in that it allows the reused content to be in a valid XML file with a DTD. The net result is that reused content gets validated at authoring time, rather than at reuse time, catching problems at their source.


Single Source -> Multiple Formats
HTML Help, JAVA Help, Eclipse Help and PDF output. DITA eliminates the
need to maintain multiple version of the same documents; a process which can
be both error-prone and time consuming.
Content can be reused within and across topics and output formats, making
updating documents easier and reducing development time.
Reuse Content
DITA conditional processing provides a mechanism to produce multiple versions
of a document from the same source. Documents can be created for spefic
Multiple Versions
audience types, platforms, product versions and more, without needing to
maintain multiple sets of content.
Formatting is applied according to your style guidelines by stylesheets, freeing
the writer to concentrate on writing content.
Separation of Content
and Formatting
The DITA DTD assists you in maintaining information that is consistently and
logically formatted and structured across a document set.
Consistency
DITA specialization architecture allows you to use a vocabulary for your XML
that is meaningful to other writers.


Creating DITA

DITA content can be created using any good XML editor. The most useful feature of any editor is the ability
to validate against the DITA DTD. Another extremely useful feature is a menu or list of valid tags that you
can choose from at any point during the creation or editing of a topic.
Even if you choose an editor that gives you a formatted view of your content as you edit it, you will still need
to be familiar with XML, structured document concepts and the general structure of DITA documents. Otherwise
you will find yourself becoming frustrated by the seemingly illogical procedures for adding tags and content.
You can choose to combine multiple topics in a single XML file by using the tag as the root tag and
creating topics as its children. I prefer to create a single topic per XML file. This can be helpful when you don't
have an expensive content management system, since you can include useful information in the filename
such as the topic type and id i.e concept_creating_content.dita as a first step in managing your content. I find
this invaluable when I am building my ditamaps. It also helps to maintain a 'topic-based' approach to your
content rather than 'book-based' which will allow you to take fuller advantage of DITA content reuse and
conditional processing functionality.
You will need to plan the directory structure of your content files, map files and build scripts. Once again, the
file system can be a useful tool for content management for smaller DITA implementations. Create different
directories for content for different products or other major category and another for common content that will
be shared across many docs.You will also need to plan locations for output for different documents and
formats.
The diagram below shows the directory structure that I use for my content. In keeping with the content reuse
approach, I keep my map files separate from my content files. A map could include content from multiple
content areas/directories to produce a variety of documents.
Aim to keep your content files in a sub-directory of your maps directory. If you have a path which contains
"../" in topicrefs in a map file, you can end up with additional directories in your output directory.
Figure






The DITA Open Toolkit uses a standard XML catalog resolver. This means that you do not need to change
the DTD reference in your content files when you change their path or create files in a new location. An XMLcatalog maps a location to a public identifier. The public identifier is referenced in the DOCTYPE declaration
in your content files and allows the DTD location to be resolved.

Before you start writing

Before you start producing your word-processed report you must make sure you do the
following:

• Decide what the objective of the report is. This is critical. If you fail to do this you will
almost certainly produce something that is unsatisfactory. Every report should have a
single clear objective. Make the objective as specific as possible.

• Write down the objective. Ideally, this should be in one sentence. For example, the
objective of this document is “to help students write well structured, easy-to-understand
technical reports”. The objective should then be stated at the beginning of the report. If
you cannot write down the objective in one sentence, then you are not yet ready to start
any writing.

• Always have in mind a specific reader. You should assume that the reader is intelligent
but uninformed. It may be useful to state up front what the reader profile is. For example,
the target readers for this document are primarily students and researchers with a good
working knowledge of English. The document is not suitable for children under 13, or
people who have yet to write documents in English. It is ideal for people who have
written technical or business documents and wish to improve their writing skills.

• Decide what information you need to include. You should use the objective as your
reference and list the areas you need to cover. Once you have collected the information
make a note of each main point and then sort them into logical groups. Ultimately you
have to make sure that every sentence makes a contribution to the objective. If material
you write does not make a contribution to the objective remove it – if it is good you may
even be able to reuse it in a different report with a different objective.

• Have access to a good dictionary. Before using a word that ‘sounds good’, but whose
meaning you are not sure of, check it in the dictionary. Do the same for any word you are
not sure how to spell.

• Identify someone who can provide feedback. Make sure you identify a friend, relative or
colleague who can read at least one draft of your report before you submit it formally. Do
not worry if the person does not understand the technical area – they can at least check
the structure and style and it may even force you to write in the plain English style
advocated here.
The following checklist should be applied before you give even an early draft of your
document out for review:

• Check that the structure conforms to all the rules described in this document.

• Run the document through a spelling checker.

• Read it through carefully, trying to put yourself in the shoes of your potential readers.

Technical writing.Explained in detail..

What is Technical writing?.

Technical writing is all about communicating some useful information to the intended audience in an easy way. You need to have clarity of expression,basic knowledge of internet and computers to be a good Technical writer.

Do you need to be creative to become a Technical writer?.

The answer is NO.

You should be good at English Grammar,and need to have clarity of expression,basic knowledge of internet and computers.



What does a Technical Writer do?.

Technical writer normally creates Product User manuals,installation guides,Online Tutorials,presentation documents.

Technical writers follow Document Development Life Cycle (DDLC) to develop any Document.


What is DDLC ( Document Development Life Cycle)?.

In software development, software developers follow SDLC (Software Development Life Cycle).

When it comes to Technical writing we have DDLC(Document Development Life Cycle).

While Preparing a document,it goes through various phases.All these phases collectively called as DDLC.


DDLC (Document Development Life Cycle) has the following Phases.

1. Requirement Specification.

2. Audience Research.

3. Analyzing Product.

4.Deciding Table of Contents and Graphical content.

5.Collecting information.

6.Review by Technical Panel.
.
7.Editorial Review.

8.Analyzing and Reviewing Beta Version.

9.Getting Approval From Quality and assurance team (If necessary).

10.Releasing document.

Technical writing is a great career for all those who are passionate about writing,who are technically vibrant enough to describe any issue related to computers and Information Technology.


A Technical writer can also work as a Freelance Technical writer and can earn a good amount of money.

Technical writer roles and responsibilities

A technical writer basically prepares and develops clear, concise written documentation which communicates technical information to a target audience. Some common examples of technical writing include user manuals for software, documentation guides for electronic products,machinery and design or specifications for projects related to IT/ITES field. This is a very diverse field,it is rapidly growing.

Golden rule

Write to inform, not to impress!!
If you wish to be a writer, write!
-Epictetus

What is Technical writing ?

Technical writing is all about communicating an idea or some useful information to the intended audience in an easy way.
>