NIH | National Cancer Institute | NCI Wiki  

Error rendering macro 'rw-search'

null

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Continued revising based on review feedback from Barry Alkis.

...

The documentation team can help make a project successful by performing the following tasks and others. We require a charge code for all work. We are experts at accessibility for electronic documents and will make sure that all materials we deliver are Section 508-compliant. 

  • Write user's Develop documentation such as user guides and admin guides for release in formats including Confluence, Word, and PDF. 
  • Overhaul or update existing user documentation for a new release, including release announcements.
  • Write scripts for and record explainer videos about software usage.
  • Write online help or tutorials built into the user interface of an application.
  • Write/review UI text and error messages for an application.
  • Integrate user documentation with project code in GitHub.
  • Write or edit software lifecycle documents, API guides, architecture guides, and developer documentation.
  • Analyse content in Jira, GitHub, or PowerPoint and create other documents based on that content. 
  • Create templates for developers to easily create documentation.
  • Perform file conversions, typically to Confluence wiki format, and other file operations as required.
  • Remediate any document for Section 508-compliance.
  • Support project management by preparing team process documents.

...

  • Documentation is clear and accurate, supporting ease of task completion and expanded and optimal use of applications.
  • Documentation meets accessibility standards including Section 508 compliance.
  • Documentation is organized to information within it is easy to find.
  • Wiki users are able to readily create new wikis and expand existing content, including new topics and formats.
  • Technical staff can spend more time using their unique talents instead of creating or updating user documentation. 

Documentation Feature Catalog

...