Project 2: DITA book

The DITA book is the second of two major projects for this course. The deliverables for the assignment are:

  • Ten DITA topic files: five task topics, three concept topics, and two reference topics. The content of the files are up to you but certain elements are required.
  • A DITA map file that organizes the topics
  • A topic file that contains reusable data (content reference)
  • A PDF version of the book
  • An XHTML version of the book

The files should be in a folder named yourName-ditabook where yourName is your first initial and last name (for example, vmorrow-ditabook). Save this folder to a ZIP archive of the same name and upload the file no later than midnight on the due date..

You can get an optional review two weeks before the deadline by following the directions above and notifying me that the ZIP archive has been uploaded.

This project can be broken down into stages that correspond to the material covered in the readings and exercises. This means that as soon as you get feedback on the first DITA exercise (Exercise 6), you should know enough to get started on creating DITA topics. For example, after you get feedback on Exercise 6, in which you create a concept and task topics, go ahead and start developing your those topics.

The content of your topics is up to you, but you must include five tasks, two reference, and three concept topics. For example, you could choose to document how to use your cellphone and include topics such as:

Task type Titles
Tasks
  • Making a call
  • Taking a picture
  • Reviewing your call history
  • Adding a contact
  • Sending a text message
Concepts
  • Phone model xyz
  • Phone basics
  • What is a contact?
Reference
  • Phone accessory types
  • Phone specification

Tip: If you have problems anywhere along the way, post your issue in the appropriate thread in the Blackboard Discussion Board. If you and your classmates do not post a solution in 24 hours, I will respond. Asking questions or posting solutions is part of your semester grade (participation).

The more information you include in the question or statement of your problem, the more effectively others can respond. If you have feedback about the presentation of the material, please direct it to me in an email.

Step 1: Write DITA topics

As you finish up Exercises 6 and 7, start creating your task, concept, and reference topics based on what you learned in Chapters 2 through 5 in the DITA Best Practices book. Ensure that your topics include at least one of each of the following items:

Also, ensure that all topics include a short description and that you follow the guidelines for writing short descriptions from Chapte

  • Concept topics:
    • Ordered list
    • Unordered list
    • Image
  • Task topics:
    • Context
    • Prerequisites in a task
    • Steps in a task
    • Post-requisites
  • Reference topics:
    • Simple table
    • Normal table
    • Definition list

Also, ensure that all topics include a short description and that you follow the guidelines for writing short descriptions from Chapter 6.

Not all topics have to include all things. Just make sure that you have at least one example of each thing in one of your topics for that type.

Name each of your topic files yourName-project2-topicDescription.dita, where yourName is your first initial and last name and topicDescription provides an identifier for the topic (for example, vmorrowproject2- takingPicture.dita).

Step 2: Create a map to organize the topics

After completing Exercise 8, create a map that organizes your topics into a deliverable. Include a relationship table in the map that provides links between the relevant topics.

Name your map file, yourName-project2-mapDescription.ditamap, where yourName is your first initial and last name and mapDescription provides an identifier for the map (for example, vmorrow-project2- usingMyPhone.ditamap).

Step 3: Connect the topics through cross-references

After completing Exercise 9, review your topics for ways to link the information together that would be meaningful. At a minimum, provide at least one of each of the following types of links:

  • In a task topic, include at least one link to a step or substep within the same topic.
  • In a concept topic, include at least one link to an external web page.
  • In a reference topic, link to one of your other topics (either task or reference).

Step 4: Enable reusable content in your file

After completing Exercise 10, search for terms that occur more than once in your topics and replace the term with a conref value. Store the source of the conref value in a separate topic. Also, apply metadata in your map file so that you can generate different outputs using the same map file. Name the file that contains your conref sources yourName-project2-sharedValues.dita, where yourName is your first initial and last name (for example, vmorrow-project2-sharedValues.dita).

Step 5: Generate the final output

Use oXygen to produce PDF and XHTML output.

Step 6: Upload your finished project

Once you have finished your project, zip your yourName-ditabook folder and upload it to Blackboard. Ensure that all the project files are included.