Scribd
Upload
24 views

Quickstart Guide Internal

The document provides instructions for product owners to format application documentation using Microsoft Word templates. It outlines the steps to apply correct styles for paragraphs, lists, images, tables, headings, and footers. It also describes how to search and replace deprecated terms and accept or reject tracked changes and comments before submitting documentation.

Uploaded by

lauranyc77
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
24 views

Quickstart Guide Internal

The document provides instructions for product owners to format application documentation using Microsoft Word templates. It outlines the steps to apply correct styles for paragraphs, lists, images, tables, headings, and footers. It also describes how to search and replace deprecated terms and accept or reject tracked changes and comments before submitting documentation.

Uploaded by

lauranyc77
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
You are on page 1/ 7

APPLICATION DOCUMENTATION

Formatting
Quickstart
Welcome
This Quickstart provides you with detailed instructions for working with the Pega Documentation
Microsoft Word templates. Understanding how to use these templates will enable you to easily
submit quality documentation in a timely manner. Please click here to watch the Application
Documentation Enablement video. The video demonstrates the steps found in this Quickstart.

Your PO Task Checklist


The items in the checklist are the responsibility of each product owner and ensure that your
documents will be correctly formatted. The Application Documentation team will not be able to
complete these tasks for you. If you are unable to complete the items in the checklist, your
documentation will still be packaged for release.
If you have questions please send an email to the doc team.
 Use the Text Style

 Use the Bullet Style

 Use the Numbered List Style

 Use the Image Style

 Use the Table Style

 Use the Section Header Style

 Use the Footer Style

 Search and Replace Deprecated Terms (See Page XX for Latest Terms)

 Accept/Reject Track Changes and Comments

1
The Release Documentation Process

SUBMIT FORM ACCEPT INVITE PREPARE DOCS SUBMIT DOCS


Product owners submit If dates are Product Owners use Product owners email
form and view schedule to approved, product the Quickstart their documents to
request open days with an owners must accept checklist to update, the doc team for
application documentation meeting invite from edit, and create processing one day
resource. doc team to secure release prior to their
their dates and documentation. confirmed dates.
resource.

Quick styling notes


Before you begin turn on paragraph markers to view formatting marks:
1. From the Home ribbon, click the Paragraph Mark icon

Do the following to open the Style window:


1. From the Home ribbon, click the expansion arrow under Change Styles.

Applying the template


Your document may or may not be using the appropriate Pega template. If it’s not, you must
import template. To do this:
1. From the Developer ribbon click Document Template.
Note: If your Developer ribbon is not present in the main menu, click File > Options >
Customize Ribbon. Select Developer from the left pane and add it to the right pane.
2. Ensure that Chapter Template 2014 or similar is specified.
3. If not, click Attach.
4. Browse to this folder.
5. Select Chapter Template 2014 and click Open.
6. Select Automatically update document styles.
7. Click OK.

2
How to use Text style
The correct style for paragraphs is the Text style. To ensure that your paragraphs are using this
style:
1. Place your cursor in the paragraph.
2. From the Styles window, select Text.

How to use the Bullet style


The Bullet First Level style is used for items that appear in unordered, bulleted lists. If your
audience is completing a task a numbered list should be used. You can apply a Bullet Second
Level style to sublists within these lists. To convert text that was incorrectly styled into a bulleted
list:
1. Select all the items in the bulleted list.
2. From the Styles window, select Bullet First Level.
3. To make a sub-list, select the bullet points you’d like to indent, and select Bullet Second
Level.

How to use the Numbered List style


The Numbered List First Level style is used for items that appear in steps. We can apply a
Numbered List Second Level style to substeps within these lists. To fix steps that are using the
incorrect style:
1. Select all the steps in the numbered list.
2. From the Styles window, select Numbered List First Level.
3. To make a substep, select the steps you’d like to indent, and select Numbered List
Second Level.

How to use the Image style


Special care must be used when adding graphics to a document. An improperly added graphic
can “float” sometimes over text, and sometimes behind it. A graphic must both be added
properly and be tagged with the correct style.
You can detect whether a graphic is floating by clicking on it. If an anchor symbol appears in the
top-left corner, the graphic is floating.
To fix this:

3
1. Right-click the graphic and select Save as Picture. Save the picture in a convenient
location.
2. Delete the graphic.
3. Insert a Graphic tag.
4. Click Insert > Picture and browse to where you have the picture saved.

How to use Table styles


All table text must be styled using the TableText style. All table column heads appear in the
TableColHeads style.
1. Place your cursor inside a cell in the table. This table has an incorrect Normal style
applied to the text. Switch this to TableText.
2. Select all the content below the column heads in the table, and select TableText from the
Styles window.
3. Highlight the column head row and select TableColHeads from the Styles window.
4. Sometimes a table will span several pages. You want to ensure that the column head
appears at the top of each portion of the table.
a. Right-click in the table and select Table Properties.
b. Select the Row tab.
c. Select the Repeat as header row at the top of each page check box

How to use the Section Header style


There are six heading levels available in our template, though we mostly just use four. Heading
levels are important because they determine markers in the table of contents. Any heading level
from 1-3 will appear in the table of contents hierarchy.
Heading 1 should only be used for chapter titles.
Heading 2 is used for the major subsections of your chapter.
Heading 3 is used for subsections of the main sections
It is also important that there are no blank headings in the document. These will appear in the
table of contents.

How to use the Footer style


Footers contain the title of your book and the page number. The page number is automatically
generated by the template, and the number in the header on the first page of the chapter

4
template. It is your responsibility to populate the book title field. Please don’t add your release
number to the footer. Leaving the release number out eliminates an extra updating step for
each release.
The template has a generic title, Generic Document Template 2014. To replace this:
1. Double-click in the footer of the first page.
2. Highlight the text Generic Document Template 2014. Replace it with the name of your
application and the book type, for example, Pega Application User Guide.
3. Double-click in the main part of the document. Your title is now applied to every page in
the chapter.

How to Search and Replace


deprecated terms
It is important to ensure that your documents are not using terms that are no longer used by
Pega. You can quickly search and replace these terms by doing the following:

1. In the Home ribbon, click Replace.


2. Type a deprecated term in the Find what: field.
3. Type the replacement term in the Replace with field.

Note: You can click More for more search options, such as case sensitivity.

Latest terms used


Here is a brief list of words to avoid:

PRPC Replace with Pega 7 Platform

Framework Replace with application or foundation, depending on the context

RuleSets Remove camel case. Should be rulesets

Workbasket Replace with work queue

Out of the Box Replace with Pega-provided

For a complete list of terms, words, and phrases to use and avoid, see
https://mesh.pega.com/docs/DOC-40740

5
How to Accept/Reject tracked changes and
add comments
Tracked changes enable you to quickly determine where your team has made updates to the
documentation. Therefore, you can save time by reviewing only new content. You can also write
comments in the document by using Word’s Comment feature. You must ensure however that
all comments are deleted before sending the document to the Application Documentation team.

Turning on tracked changes


1. From the Review ribbon, click Track Changes.

Accepting and rejecting tracked changes


1. From the Review ribbon, click Next to jump to the first tracked change.
2. Review the changes and click Accept and Reject, as necessary.
3. Run spell check on your document to ensure that no errors were introduced in the new
content.

Adding comments
1. From the Review ribbon, click New Comment.
Note All comments must be removed prior to submitting the document to the Application
Documentation team.

You might also like