Document Type: TechNote OR FAQ Product(s): Product "sales name" Version(s): Build numbers TechNote/FAQ applies to, if not all builds of product. Else, enter "All" Original Author: Author name, Bentley Technical Support Group OR Bentley Technical Support Group
Document Type: TechNote OR FAQ
Product(s): Product "sales name"
Version(s): Build numbers TechNote/FAQ applies to, if not all builds of product. Else, enter "All"
Original Author: Author name, Bentley Technical Support Group OR Bentley Technical Support Group
This is a quick template and format reference for creating a TechNote or FAQ (You must be authorized to do so by Bentley's Technical Support group). It includes the template and information about the correct content and style for TechNotes and FAQs.
This page uses the correct TechNote/FAQ format. In your own TechNote or FAQ, make sure you have all of the following components:
For more information about any of these areas, read about them in this article (use the Topics Contents box above for easy navigation).
Already know how to create your TechNote or FAQ? Go straight to the Template .
Go the wiki product page that will link to your TechNote/FAQ, click "Edit this topic" (top left of the page). Then enter your new title enclosed in double square brackets into the appropriate area (Figure 1.) After you click Save, you should be able to click your title in the product page and create the new topic.
Figure 1.
Note: To minimize ambiguity, confusion, and future conflict, use a descriptive, in-context title for the wiki article -- it doesn't have to be long, just unique. It is recommended to use at least two words for the wiki article title. An FAQ should consist of a title such as "General WaterGEMS FAQ" or "Modeling Fire Flow in WaterGEMS FAQ".
There are two ways to start a TechNote/FAQ -- use ONE of the following options that you are most comfortable with:
==== Start your copy below this line ====
Document Type: XXXXXXX(TechNote, FAQ, etc.)XXXXXXX Product(s): XXXXXXXXXXXXXXXXXXXXXXX Version(s): XXXXXXXXXXXXXXXXXXXXXXX Original Author: XXXXXXX(You may include author's name here)XXXXXXX, Bentley Technical Support Group
Document Type: XXXXXXX(TechNote, FAQ, etc.)XXXXXXX
Product(s): XXXXXXXXXXXXXXXXXXXXXXX
Version(s): XXXXXXXXXXXXXXXXXXXXXXX
Original Author: XXXXXXX(You may include author's name here)XXXXXXX, Bentley Technical Support Group
XXXXXXXXXXXX(Body of the TechNote or FAQ)XXXXXXXXXXX
Product TechNotes and FAQs
XXXXXXXXXXX(Title of product page that links or will link to new page)XXXXXXXXXXXX
Bentley Technical Support KnowledgeBase
Bentley LEARN Server
Bentley's Technical Support Group requests that you please submit any comments you have on this Wiki article in the "Comments" area below. THANK YOU!
==== End your copy just above this line ====
OPTION 2 - HTML
<p><a href="http://selectservices.bentley.com/en-US" title="SELECT Services Online"></a> <a href="http://selectservices.bentley.com/en-US"><img src="http://communities.bentley.com/Other/Old_Site_Files/Bentley_Folders/m/support/17560/download.aspx" border="0" height="56" width="175" /></a> </p><h1>Document Information</h1><blockquote><p><strong>Document Type:</strong> XXXXXXX(TechNote, FAQ, etc.)XXXXXXX</p><p><strong>Product(s):</strong> XXXXXXXXXXXXXXXXXXXXXXX</p><p><strong>Version(s):</strong> XXXXXXXXXXXXXXXXXXXXXXX</p><p><strong>Original Author:</strong> XXXXXXX(You may include author's name here)XXXXXXX, Bentley Technical Support Group</p></blockquote><h1>Overview</h1><p>XXXXXXXXXXXX(Body of the TechNote or FAQ)XXXXXXXXXXX</p><h1>See Also</h1><p>[[SELECTsupport TechNotes and FAQs]]</p><h1>External Links</h1><a href="http://appsnet.bentley.com/kbase/" title="KnowledgeBase">Bentley Technical Support KnowledgeBase</a><p><a href="http://lms.bentley.com" title="LEARN Server">Bentley LEARN Server</a></p><h1>Comments or Corrections?</h1><p>Bentley's Technical Support Group requests that you please submit any comments you have on this Wiki article to the "Comments" area below. THANK YOU!</p><p> </p><div class="hr"></div><p></p>
If you followed the instructions for either of the options above, the result should appear in the text box in the correct format (Figure 2).
Figure 2.
IMPORTANT: Replace each "XXXXXXXXXXXXXXXXXXXXXXX" with the appropriate information
A TechNote is a document that provides information or procedures related to a single Bentley software topic. Information in a TechNote is typically quite detailed and includes such content as step-by-step instructions and supporting graphics.
The purpose of an FAQ is to provide brief answers to common questions about a software product or a particular aspect of a product. It should have multiple questions and answers related to the product or subject area. The questions should be styled as "Heading 1" and the answers as "Paragraph" for easy navigation.
In your new TechNote or FAQ, use this area to provide a brief description of what the article is about.
Under this area, put in double square brackets [ ] titles of related wiki pages (within Be Communities), including the product page of your new TechNote/FAQ. To see how it should appear once it's saved, go to See Also.
Add links to any helpful external resources by entering the name and using the hyperlink button to provide the URL.
For major headings in a TechNote or questions in an FAQ, use the "Heading 1" style from the list box above. Heading items will be automatically listed in the Contents box that is generated automatically when you save the page.
The body text should use the "Paragraph" style. Note: In FAQs, just format the answers like body text. Do not label them as "Answer:" or "A:"
You can do bulleted or numbered lists using the buttons found in edit mode.
You can also do nested list items if needed by using the Indent button.
You can also use the "Code" style to insert short tips or notes.
Here is what a note looks like in the "Code" style.
You can insert a graphic such as a screen capture using the "Link to Image" button. You have to provide a URL for the graphic or link to where you've stored it in a Wiki gallery.
Please left-justify graphics.
For questions on how to use this template, please contact Kristen Dietrich.