Free Trial

Safari Books Online is a digital library providing on-demand subscription access to thousands of learning resources.

  • Create BookmarkCreate Bookmark
  • Create Note or TagCreate Note or Tag
  • PrintPrint
Share this Page URL
Help

Chapter 12. DITA Code Editing > Preparing for Code Reviews

Preparing for Code Reviews

Before you start code reviews for your teams, you need to complete these tasks:

  • Establish guidelines for most or all DITA elements. If the DITA specification and language reference aren’t clear about what DITA element should be applied to a specific type of content, clarify the DITA element usage in your own guidelines.

  • Be sure to note what type of content you should not apply a DITA element to. If the appropriate element doesn’t exist, it’s often easier to wait for a new element to be developed (or develop it yourself) than to mark content with the wrong element and have to change it later.

  • Ensure that everyone on the team uses those DITA guidelines.

  • Understand how your style sheet renders the DITA elements in the output.

  • Decide how to distribute and track files that are part of the code review process. Use a database, version control, or content management system to coordinate files. Avoid using email to track files and decisions.


  

You are currently reading a PREVIEW of this book.

                                                                                                                    

Get instant access to over $1 million worth of books and videos.

  

Start a Free Trial


  
  • Safari Books Online
  • Create BookmarkCreate Bookmark
  • Create Note or TagCreate Note or Tag
  • PrintPrint