1 / 12

Helping You Succeed

Helping You Succeed. Documentation Processes for Platform Technologies. Overview. Introduction A Document is Born Tools to Help You. Introduction.

wylie
Télécharger la présentation

Helping You Succeed

An Image/Link below is provided (as is) to download presentation Download Policy: Content on the Website is provided to you AS IS for your information and personal use and may not be sold / licensed / shared on other websites without getting consent from its author. Content is provided to you AS IS for your information and personal use only. Download presentation by click this link. While downloading, if for some reason you are not able to download a presentation, the publisher may have deleted the file from their server. During download, if you can't get a presentation, the file might be deleted by the publisher.

E N D

Presentation Transcript

  1. Helping You Succeed Documentation Processes for Platform Technologies

  2. Overview • Introduction • A Document is Born • Tools to Help You

  3. 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.

  4. 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.

  5. A Document is Born • Writer assimilates material into usable, workable next draft and returns to author/contact/content owner for comments and revisions.

  6. 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.

  7. A Document is Born • After incorporating all final changes, writer issues Knowledge Alert and publishes final version of document on Knowledge Garden.

  8. 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

  9. Tools to Help You • Documentation Specification Form – optional, but assures faster and more accurate document production.

  10. Tools to Help You • Templates provided for your convenience are available in \\devs2\groups$\OneWorld_Documentation\Platform Technologies\Documents\Document Templates

  11. Tools to Help You • All of this information is available on the Knowledge Garden under Home / Employee / Product / Software Engineering / Platform Technologies / Documentation Processes

  12. Questions? Contact Bill Calkins Senior Writer/Documentation Specialist 303-334-8942 bill_calkins@jdedwards.com

More Related