wikicicle-library

Wikicicle Warnings

Because it's a static snapshot of our Genesys Documentation site, the Wikicicle should be considered a very last resort for Online Help delivery because it negates the advantage of wiki-based documents. If your Product Manager insists on delivering a wikicicle be aware of the following:

• Your team must decide whether you will be delivering such at the beginning of the release.
• The wikicicle needs to be delivered on the product media. As such, it needs to be a DVD instead of a CD because the Wikicicle is around 1 GB. The wikicicle is not available as a separate downloadable item or DVD. It also can not be downloaded from docs.genesys.com. (Note: Another option is to make the .rar file available to the specific product customers via FTP. However, the Product Manager would have to determine how to make that available to the product customers.)
• Instructions for installing the wikicicle are in a deployment procedure delivered with the Wikicicle on the product DVD.
• It can take some time to generate the wikicicle (days).
• Since the wikicicle has to be added to the product DVD, you will must have the Online Help done at least a week before the release date to create the wikicicle. (Because you need to deliver your documents early, you lose the time up until the release date when you could have continued revising your documents and that you would have had if you did not need to deliver a wikicicle.)
• If you have links to another online document from the online Help, both documents need to be ready and released or the links won't work when the wikicicle is generated. This creates a Catch-22, if the wikicicle needs to be placed on the product DVD prior to the release.

Process

1. Request that your Project Manager add Genesys Documentation Wikicicle as an item to the Packaging Spec. See the Writer's Process tab of Packaging Spec Review/Approval process. For the wikicicle version specified in the Packaging Spec, check with Pubs Editors. For a General release, the other values for that row should be Y, Y, General, Wikicicle.
2. At least a month before the end of your project, send an email to Valentina Petrov, and copy Pubs Editors alerting them to the need for it to coordinate its creation in relationship to your product release date.
3. Request that your Project Manager opens a JIRA ticket to track the wikicicle creation process. Here is an example: PUBSWIKI-1710.
4. Prior to the wikicicle creation, your documentation content must be approved if you want the latest version of your content on the wikicicle. Communicate with your QA team, so they accommodate wikicicle testing in their schedule.

   Note: Be sure to run the Validation tool against your content to ensure that all your coding is correct (for example, that the links on a Welcome page do not use the old/no-longer-supported format). The wikicicle exposes old coding formats that will need to be corrected before the wikicicle can be frozen, thus adding overhead for you and Val.

5. Valentina creates the wikicicle and sends a Box link to it to the writer. The writer and corresponding QA team may need to test the wikicicle to confirm your content is there. (If necessary, Val can make some corrections based on the testing feedback.)

   Important: See the Wikicicle_Readme.htm for the wikicicle creation instructions located in the Box: https://genesys.app.box.com/folder/45073304952

6. Valentina generates freeze form in XING for the wikicicle and informs the writer of such. (Ideally, the writer should subscribe to the form if his or her product requires the wikicicle at each release.)
7. The writer lets the Project Manager know it's been created and available.
8. When ready, the Project Manager sends a request to create the product DVD.
9. When Genesys Production creates the product DVD, they pick up the wikicicle from the location indicated in the freeze form.

Note: If the documentation isn't approved prior to the release, the Product Manager will have to determine how to provide the wikicicle to customers post release.