DITA Survey: Questions
Personal Identification
- What is your name, affiliation, and name of your project?
- What is your personal role in your project (e.g., author, editor,
manager)?
- Are you an end user, consultant, or tool vendor?
- Is this a new survey response or a replacement for an earlier
response?
- Do you give permission for your responses to be quoted in a
summary of the results of this survey? Do you want such quotations
to be anonymous or attributed to you?
Project Identification
- What industry does your documentation represent?
- What type of processing does your project involve (authoring,
publishing, translating, indexing, analyzing, etc.)?
- How many documents or pages do you process annually? How much
of this material is new and how much revised?
- How do you publish documents (paper, PDF, Web, CD, etc.)?
- How many document tool users do you have?
- How many people use your finished documents?
- Are your documents translated to multiple languages or localized
in any other form? Are all documents localized or only some? How
many languages do you support?
- Are your documents revised and republished?
General software considerations
- What documentation
software does your project use:? Consider DITA-specific tools, XML
tools, content management, word processing, desktop publishing,
text editors, database management, project management, spreadsheets,
and any other relevant tools.
- Do you have software that enforces that writers follow your
organization's conventions?
- Do all groups within your organization use the same tools?
All people in your group?
- Is authoring geographically distributed?
- How are editing tasks assigned to individual writers or editors?
For example, is a writer responsible for a document or document
component through multiple revisions, or is an available writer
assigned whenever a change is needed? Do writers need specific expertise,
such as knowledge of a documented product, to maintain particular
pieces of content?
- Do you reuse all or parts or your documents? What size units
do you reuse? In how many documents does a typical reusable component
occur? What percentage of a typical document is comprised of reusable
segments?
DITA Considerations
- For what types of documents (user manuals, online help, test plans,
requirement specifications, journal articles, technical books, technical
reports, interdepartmental memos, etc.)
- Does your project use DITA?
- Have you considered using DITA but decided not to?
- Have you never considered using DITA?
- Do you use DITA-inspired naming of element and attribute types
when you do not use DITA itself?
- Do you use DITA maps?
- Do you specialize (modify) the DITA tagging scheme? How extensive
are your changes? Which of the following do they involve:
- Rename existing element and attribute types
- Change the definitions of existing element and attribute types
- Add new element and attribute types
- How many of the DITA element and attribute types do you use?
- What were the primary factors in deciding whether to use DITA (for example, eliminates
need to define a tagging scheme, availability of DITA open toolkit,
a DITA deliverable is part of the project, wanted to use DITA- based
software, recommended by consultant, addresses usability, effort required)?
- Who are the primary decision makers on DITA issues (for example,
customer, consultant, manager, tools group, writers)?
- Do you transform your documents to or from DITA for different
types of processing? Explain.
- In what circumstances would you recommend that an organization
consider DITA?
- What have you found surprising about DITA?
- How well have the effort, elapsed time, and cost of your solution
corresponded to your expectations at the beginning of the project?
- How well have the results corresponded to your expectations?
- Given the experience you have gained, would you make the same
DITA-related decisions now?
- What version(s) of DITA do you use? Are you planning to use
any others? When?
- What changes to DITA or the Open Toolkit would you like to see?
- What changes to your processes do you plan?
Other comments
- Please make any other relevant comments.