![]() ![]() This process permits you to be sure that only what you intend will actually be installed. Since your changes will be carried out by software, there is a difference determination process that identifies exactly what and where changes will be made. As a documentation support person, your task is to shepherd your modifications through all stages from start to finish.Īt each stage, you must validate your changes to assure that they are both valid and have the intended effect, and you must address any errors or unexpected changes that are found. Later in the process, the XML files are converted to other versions (HTML, PDF, etc.) for viewing. These source files use a special markup in XML to provide structure. For background on these tools, see Build Tools.Īny changes you make will be inserted into local copies of the source documentation files and subsequently transferred to the main documentation set. The tools and the process are outlined in this page. These aspects require that documentation contributors learn and use several specialized tools to engage the process. It also requires contributors to check their contributions for compatibility by compiling the documentation before final submission. This includes using a version control system (VCS) to coordinate contributions from disparate sources, as well as using DocBook, a semantic markup language for technical documentation based on eXtended Markup Language (XML) for the actual edits. This ensures that changes are made consistently and reliably. The documentation update process uses the same software management tools that are used for updating the program itself. Preface and Introduction - What to expect ![]() 5.1.5 Adjusting an Image's Dots Per Inch.4 References to Supporting Technologies Used.3.6 Ensure Only Expected Changes Have Been Made.3.5.3 Completeness Check: After Adding, Moving or Deleting Files.3.4.3 Telling the Program of a New Help Context.3.1 Create a Place to Attach and Discuss Your Changes.1 Preface and Introduction - What to expect.
0 Comments
Leave a Reply. |