Documentation Infrastructure - 2007

1. Documentation Infrastructure - 2007 Write, build, test, deliver, maintain

2. Overview • Getting help • The information architecture we support • Build projects and source control • Documentation build validation testing • Documentation translation verification testing

3. Getting help • Everything described in this presentation is documented: • The writer’s processes are documented in the teamroom under Infrastructure. • The infrastructure team’s processes and build system reference are documented in the infrateam information center (shown).

4. The information architecture we support • A plugin is the smallest transportable unit of components. It can be reused in multiple information centers. Rebuilding might be necessary:- if different maps are used- if topics are conditionally coded • The common plugins rarely change. They are translated once and used for items such as: CSS files, notices, trademarks, accessibility topics, and the feedback page. • The functional plugin is redelivered with each release or update. It contains release-specific build info: conrefs and headers/footers.

5. Build projects and source control • Each production cycle has its own build project. Each build project makes use of the production release and a committed release in CMVC. • The production release is used for all current development, no matter the project. The source from this release is used in the project’s test information center, used for pre-delivery tests and doc reviews. • A committed release is branched-off and the source for each plugin is promoted to this release when it ships to translation. The release will contain en-US and the returned NL files. The files from this release are used in the project’s committed information center, used for NLS verification and FVT.

6. Documentation build validation testing • Communicate • Provide the translation coordinator and NL planners with the book-to-plugin relationships. They commit to translate based on this information. • The project lead enters the plugin shipment data into the project database. This data is used to drive the build and pakpak information. • Edit, build, and test, test, test.. • Full nightly builds and on-demand delta builds are provided for the writers. • Writers are able to run full system tests and check for: • Transform errors • Broken links • Incorrect spelling • Proper word use • Accessibility

7. Documentation build validation testing • Communicate • Provide the translation coordinator and NL planners with the book-to-plugin relationships. They commit to translate based on this information. • The project lead enters the plugin shipment data into the project database. This data is used to drive the build and pakpak information. • Edit, build, and test, test, test.. • Full nightly builds and on-demand delta builds are provided for the writers. • Writers are able to run full system tests and check for: • Transform errors • Broken links • Incorrect spelling • Proper word use • Accessibility

8. Documentation build validation testing • Communicate • Provide the translation coordinator and NL planners with the book-to-plugin relationships. They commit to translate based on this information. • The project lead enters the plugin shipment data into the project database. This data is used to drive the build and pakpak information. • Edit, build, and test, test, test.. • Full nightly builds and on-demand delta builds are provided for the writers. • Writers are able to run full system tests and check for: • Transform errors • Broken links • Incorrect spelling • Proper word use • Accessibility

9. Documentation build validation testing • Communicate • Provide the translation coordinator and NL planners with the book-to-plugin relationships. They commit to translate based on this information. • The project lead enters the plugin shipment data into the project database. This data is used to drive the build and pakpak information. • Edit, build, and test, test, test.. • Full nightly builds and on-demand delta builds are provided for the writers. • Writers are able to run full system tests and check for: • Transform errors • Broken links • Incorrect spelling • Proper word use • Accessibility

10. Documentation build validation testing • Communicate • Provide the translation coordinator and NL planners with the book-to-plugin relationships. They commit to translate based on this information. • The project lead enters the plugin shipment data into the project database. This data is used to drive the build and pakpak information. • Edit, build, and test, test, test.. • Full nightly builds and on-demand delta builds are provided for the writers. • Writers are able to run full system tests and check for: • Transform errors • Broken links • Incorrect spelling • Proper word use • Accessibility

11. Documentation build validation testing • Communicate • Provide the translation coordinator and NL planners with the book-to-plugin relationships. They commit to translate based on this information. • The project lead enters the plugin shipment data into the project database. This data is used to drive the build and pakpak information. • Edit, build, and test, test, test.. • Full nightly builds and on-demand delta builds are provided for the writers. • Writers are able to run full system tests and check for: • Transform errors • Broken links • Incorrect spelling • Proper word use • Accessibility

12. Documentation build validation testing • Communicate • Provide the translation coordinator and NL planners with the book-to-plugin relationships. They commit to translate based on this information. • The project lead enters the plugin shipment data into the project database. This data is used to drive the build and pakpak information. • Edit, build, and test, test, test.. • Full nightly builds and on-demand delta builds are provided for the writers. • Writers are able to run full system tests and check for: • Transform errors • Broken links • Incorrect spelling • Proper word use • Accessibility

13. Documentation build validation testing • Communicate • Provide the translation coordinator and NL planners with the book-to-plugin relationships. They commit to translate based on this information. • The project lead enters the plugin shipment data into the project database. This data is used to drive the build and pakpak information. • Edit, build, and test, test, test.. • Full nightly builds and on-demand delta builds are provided for the writers. • Writers are able to run full system tests and check for: • Transform errors • Broken links • Incorrect spelling • Proper word use • Accessibility

14. Documentation translation verification testing • Scripts to assist in packaging are packaged into downloadable zip files (pakpaks): • They ensure the consistency of each writer-delivered package, providing a baseline reference package. • They ensure the consistency of eachtranslator-returned package. • Consistency allows for automation: • Files are shipped automatically over FTP. • A returned NL plugin is compared against its baseline en-US plugin. • Server accepts or rejects the package and sends confirmation e-mail. • Scripts post-process the output based onerrors discovered during testing. • A PHP-driven web page communicates test status to the translators. • The committed information center is automatically updated within an hour after plugins are received. 24-7 server-uptime provides uninterrupted workflow to testers around the globe.

15. Documentation translation verification testing • Scripts to assist in packaging are packaged into downloadable zip files (pakpaks): • They ensure the consistency of each writer-delivered package, providing a baseline reference package. • They ensure the consistency of eachtranslator-returned package. • Consistency allows for automation: • Files are shipped automatically over FTP. • A returned NL plugin is compared against its baseline en-US plugin. • Server accepts or rejects the package and sends confirmation e-mail. • Scripts post-process the output based onerrors discovered during testing. • A PHP-driven web page communicates test status to the translators. • The committed information center is automatically updated within an hour after plugins are received. 24-7 server-uptime provides uninterrupted workflow to testers around the globe.

16. Documentation translation verification testing • Scripts to assist in packaging are packaged into downloadable zip files (pakpaks): • They ensure the consistency of each writer-delivered package, providing a baseline reference package. • They ensure the consistency of each translator-returned package. • Consistency allows for automation: • Files are shipped automatically over FTP. • A returned NL plugin is compared against its baseline en-US plugin. • Server accepts or rejects the package and sends confirmation e-mail. • Scripts post-process the output based onerrors discovered during testing. • A PHP-driven web page communicates test status to the translators. • The committed information center is automatically updated within an hour after plugins are received. 24-7 server-uptime provides uninterrupted workflow to testers around the globe.

17. Documentation translation verification testing • Scripts to assist in packaging are packaged into downloadable zip files (pakpaks): • They ensure the consistency of each writer-delivered package, providing a baseline reference package. • They ensure the consistency of eachtranslator-returned package. • Consistency allows for automation: • Files are shipped automatically over FTP. • A returned NL plugin is compared against its baseline en-US plugin. • Server accepts or rejects the package and sends confirmation e-mail. • Scripts post-process the output based onerrors discovered during testing. • A PHP-driven web page communicates test status to the translators. • The committed information center is automatically updated within an hour after plugins are received. 24-7 server-uptime provides uninterrupted workflow to testers around the globe.

18. Documentation translation verification testing • Scripts to assist in packaging are packaged into downloadable zip files (pakpaks): • They ensure the consistency of each writer-delivered package, providing a baseline reference package. • They ensure the consistency of eachtranslator-returned package. • Consistency allows for automation: • Files are shipped automatically over FTP. • A returned NL plugin is comparedagainst its baseline en-US plugin. • Server accepts or rejects the package and sends confirmation e-mail. • Scripts post-process the output based onerrors discovered during testing. • A PHP-driven web page communicates test status to the translators. • The committed information center is automatically updated within an hour after plugins are received. 24-7 server-uptime provides uninterrupted workflow to testers around the globe.

19. Documentation translation verification testing • Scripts to assist in packaging are packaged into downloadable zip files (pakpaks): • They ensure the consistency of each writer-delivered package, providing a baseline reference package. • They ensure the consistency of eachtranslator-returned package. • Consistency allows for automation: • Files are shipped automatically over FTP. • A returned NL plugin is compared against its baseline en-US plugin. • Server accepts or rejects the package and sends confirmation e-mail. • Scripts post-process the output based onerrors discovered during testing. • A PHP-driven web page communicates test status to the translators. • The committed information center is automatically updated within an hour after plugins are received. 24-7 server-uptime provides uninterrupted workflow to testers around the globe.

20. Documentation translation verification testing • Scripts to assist in packaging are packaged into downloadable zip files (pakpaks): • They ensure the consistency of each writer-delivered package, providing a baseline reference package. • They ensure the consistency of eachtranslator-returned package. • Consistency allows for automation: • Files are shipped automatically over FTP. • A returned NL plugin is compared against its baseline en-US plugin. • Server accepts or rejects the package and sends confirmation e-mail. • Scripts post-process the output based on errors discovered during testing. • A PHP-driven web page communicates test status to the translators. • The committed information center is automatically updated within an hour after plugins are received. 24-7 server-uptime provides uninterrupted workflow to testers around the globe.

21. Documentation translation verification testing • Scripts to assist in packaging are packaged into downloadable zip files (pakpaks): • They ensure the consistency of each writer-delivered package, providing a baseline reference package. • They ensure the consistency of eachtranslator-returned package. • Consistency allows for automation: • Files are shipped automatically over FTP. • A returned NL plugin is compared against its baseline en-US plugin. • Server accepts or rejects the package and sends confirmation e-mail. • Scripts post-process the output based onerrors discovered during testing. • A PHP-driven web page communicatestest status to the translators. • The committed information center is automatically updated within an hour after plugins are received. 24-7 server-uptime provides uninterrupted workflow to testers around the globe.

22. Documentation translation verification testing • Scripts to assist in packaging are packaged into downloadable zip files (pakpaks): • They ensure the consistency of each writer-delivered package, providing a baseline reference package. • They ensure the consistency of eachtranslator-returned package. • Consistency allows for automation: • Files are shipped automatically over FTP. • A returned NL plugin is compared against its baseline en-US plugin. • Server accepts or rejects the package and sends confirmation e-mail. • Scripts post-process the output based onerrors discovered during testing. • A PHP-driven web page communicates test status to the translators. • The committed information center is automatically updated within an hour after plugins are received. 24-7 server-uptime provides uninterrupted workflow to testers around the globe.