Categories: All - process - comments - approval - documentation

by Artur Boldariev 7 years ago

378

day7_documentation

The document outlines the structure and protocols for managing a product library, specifically focusing on LEIS, LEIS NP, and ISGT. It provides links to various active and shared folders where files are stored, including specific locations for LEIS and ISGT shared servers.

day7_documentation

Documentation

AFS - approval flow system

User guide
Process

1. Don't forget to attach new doc after dispositions and increase Rev of document by 1
2. PDF file should be added, not a Source
3. Attachment could not be the same as Flow name

After receving Approved Status, upload the document to the Library (Pdf with Source)

Source = *doc (frame maker files)

Updated document must always be uploaded instead of the older one with incremented revision in the document name. Old version of documents must be deleted. Comments from corresponding stakeholder/reviewer must be answered as FIXED.
Wait until comments will be received with dispositions.

Important: Disposition 2 may not be changed during approval process. Disposition 3 - is going to hell :)

Start the flow
Assign attributes, reviewers, stakeholders, issue/due dates and all the required info according to RTS template. Save changes!
Create a Flow by choosing correct RTS template

QMO RTS template must be chosen for all release specific documents

Create a document or update existing according to newest template.

QMO

Software Metrix
Document Control Procedures
General rules: Copy document data from old document into an up-to-date template
Check up the templates
Templates

A careful review of the recommended contents of the templates listed here is suggested before a decision is made to make changes. If a product team's needs can best be met by making additions or deletions, then the appropriate changes may be made with certain exceptions. The checklists cannot be modified. For other templates, in the case of deletions, product teams need to ensure that the overall value of the document is not reduced as a result of the deleted sections. For those sections that do not apply to a specific release, a Not Applicable (N/A) designation is recommended rather than deletion of the section. This indicates that consideration to all sections of the document has been made even those designated as Not Applicable. For those sections that do not apply to a product, the section may be deleted.

Product library ISGT/LEIS/LEISNP

E/// shared folders and libraries
ISGT shared folder

\\rrc-dte-shr01.cc.telcordia.com\vol291\GTAC\

KT Records Wave2

\\belmar-dmz.cc.telcordia.com\gl_training\Wave2

LEIS & LEIS-NP Shared File Servers

\\seaside-dmz.cc.telcordia.com\leis_desktopservices\

LEIS Web urls

\\seaside-dmz.cc.telcordia.com\leis_desktopservices\LEIS-CLASSIC

LEIS shared server

\\seaside-dmz.cc.telcordia.com\leis_desktopservices\LEIS-NP

Old libraries, used for reference:
QMO library
Electronic Library
Active up-to-date libraries links:
E/// documents
Department 6264 site
LEIS, LEIS NP & ISGT
21 active LEIS Documents (25 archived/retired) Of these, 5 LEIS/LEAD documents have been updated in recent years 5 active LEIS-NP Documents

Главная тема

LS Documentation/Online Help

DEVELOPMENT
Updating Online help

Go to WinCVS (ask CMO for Help to donwload the source files)

1)Uncheck the source 4) go to cvs and download files 5) unzip your files 6) uncheck 6) Go through approval process via word (not AFS) 7) Upload doc back to cvs

Updating User Docs (Frame + PDF)

Go t

Framemaker Lifecycle: 2) Setup a new folder (name it with a new release number) and copy paste to it from the previous edition 3) Delete old change bars first 4) Delete change history 5) Open front matter and update the variables - issue number, release number date on release number. Add draft footer and draft watemark (special - conditional text - show hide, add draft, draft date, draft footer)(if applicable, not a must) 6) Import system variables and conditional tags (file - import - formats - choose variable definitions and conditional text settings) 7) Shift save all files in the book 8) Turn on the change bars and update the text 9) Turn off the change bars and update the "Change History". Checkspell checker 10) update book (TOC and crossreferences) 11) save all the files in book 12)generate PDF

Produce quaility PDF

Send the doc for technical review to AFS, basic flow type (or e-mail)

Make the PDF ready for ASD030

Submitting the doc to IDO

PROCESS: 1) Fill in the form in IDO, attach the correct PDF Если у нас документ Эриксона, у них есть revision, и нет issue. В этом случае в IDO в графе issue ставим 00, click tag alone ID and Number, and choose Revision [REV] 2) Select the approver and send the PDF to him for approval 3) After you get your doc approved, submit it to IDO.

PLANNING
Get from RM: PT test date GA Release date

Download the LS Blueprint from the QMO website Download the LS schedule from project shared folder Populate both of the documents with the apppropriate data

"Scheduled Finish" in Blueprint must comply with "PT ready" date in LS Schedule

Upload the documents to the project's release shared folder

Update these correspondingly

Update when:
actual start occured
the first draft sent
you got your last comments to the draft
document was ready for PT(/Actual finish (Blueprint)
you got your last comments after PT
Ready for IDO/Available in IDO/In CDQRS


REQUIREMENT ANALYSIS
Get input from: Software Requirements doc (ILS section) Documentation MR Meetings (MR, Release, etc) and communicaton with SME Readme files in the Frame Document

test

onTrack

Statuses
defer - will not be fixed
ncclose (no change close) - closed, not a bug
tsthold (test hold) - waiting for QMO docs (blueprint is not approved...)

Axess Point - Application to search for Telcordia external docs

ASD-030 Web-based Application - Used to submit documents to AXESS Point