When updating GB922 series guidebooks you should follow these guidelines:
- File name: For example, GB922-1BI_Business_Interaction_Rxx-x_vz-z…the release is xx-x and the version z-z should be .1 added to the prior version
- Make certain the spell and grammar checkers are on (US English)
- Turn Track Changes mode on so that changes can be found and reviewed. Changes will be accepted when the document is published for evaluation.
- Title page
- Change the subheading to “TM Forum Member Evaluation – Version xx.x (use the updated version number as indicated above)
- Change the date to Month, Year applicable
- Change the Notice page to the “unapproved” text, which can be found in the guide book templatehere (look for TMF407, in the zip file open TMF407_GuideBkTemplate_V1-4.doc (version may change over time) and the text in the Notice page is the "unapproved" version.)
- For added text
- Arial 11, justified
- Paragraph – line spacing 6pt before and after, keep lines together
- Arial 11, justified
- For added figures – use the convention that is in the existing document for figure captions
- Check to make certain all figures, including existing ones, have the caption on the same page as the figure
- Add data dictionary entries for new entities/attributes (note: this assumes the data dictionaries are not yet generated from the model)
- Remove data dictionary entries for deleted entities/attributes or moved to another guide book
- Update the release and version number tables at the back of the guide book
- Update the table of contents and table of figures when complete
- Place the document in the SID release Submitted Docs folder in the SID Project Workspace.