PDFs
Writer: Use this topic to attach space PDFs, PDFs of unconverted content, and other product documents that support this release. Do not attach PDFs for other products.
- Attach product PDFs and other supporting documents to this topic.
- Populate the tables with the title (not file name), document creation date, file size, and description of each document.
- Link to each attachment from its title in the tables.
- In the export a custom PDF hyperlink, replace spacekey with the space key for the product space.
This topic describes and links to PDFs and other documents that support this product release. If the ready-made PDFs of this space do not satisfy your requirements, you can export a custom PDF.
Ready-made PDFs of this space
Writer: Create and post PDFs of your complete space when the space is first released (GA) and for every subsequent release vehicle (service pack, patch, maintenance release, and so on) that is documented in this space. Having these PDFs available for download will divert PDF-seeking users from using the PDF export functionality, which stresses the system.
- Complete means all user content, not every topic in the space. Omit (this topic, to prevent duplication), Tracking-tools, and all topics outside of the Home page hierarchy, such as:
- Legal-notices
- Third-party-product-terms-of-use
- Inclusions libraries
- Providing a space PDF at SMA release is not required. If you do this, you must later replace the SMA PDF with the GA space PDF to simplify the experience for most of your users. Be sure to update the document properties in the Ready-made PDFs table.
- Do not create PDFs for subsets of the space. Creating PDFs of selected topics and sections will fragment the documentation into guides again, introduce inconsistency among products, and require extra production work (e.g., different cover pages for each PDF).
- If your space was released to customers prior to April 19, 2012, export a PDF of your current content and then for every future release vehicle. In this situation, name your first PDF for your most recent release vehicle and, if you made updates to the space after the release, include the Post- prefix.
The example entries in the following table list PDFs for a space released well before the space PDF requirement, where Service Pack 4 came out earlier in 2012, and the IDD team made changes to the space between that service pack and the first snapshot.
The following table provides ready-made PDFs that contain snapshots of the content in this space. Ready-made PDFs are created for new releases and service packs at the time of their release. Although these PDFs contain all topics, the content of some topics is better suited for online viewing.
Ready-made PDFs
Snapshot | Date | File size |
---|---|---|
July 15, 2012 | 300 KB | |
May 13, 2012 | 300 KB | |
April 19, 2012 | 298 KB | |
releaseAsLink | creationDate | fileSize KB |
releaseAsLink | creationDate | fileSize KB |
Product guides
The following table lists PDFs of product guides that are not available as topics in the documentation portal.
Product guide PDFs
Title | Date | File size | Description |
---|---|---|---|
docTitleAsLink | creationDate | fileSize KB | Describes ... |
docTitleAsLink | creationDate | fileSize KB | Describes ... |
Related topics