...
| Section |
|---|
| Column |
|---|
| PurposeThis space provides information, tools and file storage for development of end user documentation for OLE. Most end users work in various departments within the library system and are not IT specialists. OLE documentation for end users includes user guides and online help, both of which are intended for use as aids in training new users and, thereafter, for reference. See: |
| Column |
|---|
| Panel |
|---|
| borderColor | #97A0A9 |
|---|
| bgColor | #F8FCFF |
|---|
| titleBGColor | #F2F8FF |
|---|
| title | Contents |
|---|
| borderStyle | dashed |
|---|
| |
|
|
Writers Responsibilities
Writers for OLE Documentation are responsible for:
- Obtaining content from functional specs, SMEs, and their own work in the KFS UI. Test Scripts may provide useful also. Nora has added comments that include links to OLETS (the OLE Test Jira ticketing system)
- Writing clear and concise user documentation in the OLE templates provided, according to OLE team standards for content, usage, punctuation, etc.
- Working with SMEs while preparing the original draft and during review cycles in order to improve the quality of content and presentation.
- Storing all drafts as attachments to the Documentation Sandbox
- Handing off drafted sections to ...