Helping You Succeed
12
Helping You Succeed Documentation Processes for Platform Technologies
description
Helping You Succeed. Documentation Processes for Platform Technologies. Overview. Introduction A Document is Born Tools to Help You. Introduction. - PowerPoint PPT Presentation
Transcript of Helping You Succeed
Helping You Succeed
Documentation Processes for
Platform Technologies
Overview
Introduction A Document is Born Tools to Help You
Introduction
Platform Technologies Documentation exists to provide a way to communicate with customers, business partners, and other departments at J.D. Edwards.
Documentation helps you succeed at your job by recording what you do and presenting it to the rest of the world.
A Document is Born
Author/Primary Contact/Content Owner requests documentation, communicates with writer about content, objectives, and timeline and provides rough draft. This person owns the paper from start to finish and is responsible for all content.
A Document is Born
Writer assimilates material into usable, workable next draft and returns to author/contact/content owner for comments and revisions.
A Document is Born
After author/primary contact/owner is satisfied with document, writer sends out for review requesting last-minute comments, corrections, and suggestions.
A Document is Born
After incorporating all final changes, writer issues Knowledge Alert and publishes final version of document on Knowledge Garden.
Tools to Help You
Documentation Specialist/Technical Writer Oversees documentation production Manages Document Library on Knowledge Garden Assists with writing Edits for standards, consistency, format, and clarity Provides tools (templates, forms, etc.) Participates as necessary in project meetings Does whatever is necessary to help you get that document
published
Tools to Help You
Documentation Specification Form – optional, but assures faster and more accurate document production.
Tools to Help You
Templates provided for your convenience are available in \\devs2\groups$\OneWorld_Documentation\Platform Technologies\Documents\Document Templates
Tools to Help You
All of this information is available on the Knowledge Garden under Home / Employee / Product / Software Engineering / Platform Technologies / Documentation Processes
Questions?Questions?
Contact Bill CalkinsSenior Writer/Documentation Specialist
303-334-8942
Contact Bill CalkinsSenior Writer/Documentation Specialist
303-334-8942
