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.

...

  • Write user's guides for release in formats including Confluence, Word, and PDF. 
  • Overhaul or update existing user documentation for a new release.
  • Integrate user documentation with project code in GitHub.
  • Write/review UI text and error messages for an application.
  • Create explainer videos about software usage.
  • Write or edit software lifecycle documents, API guides, architecture guides, and developer 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.

...

Send the following information in an email message to the NCI Leidos-CBIIT Documentation Team.

  • Your first and last name
  • Your organization (please spell out acronyms)
  • Your request (Notice the suggested tasks below.)request 

Determining Level of Effort

The documentation team can work with the Technical Project Manager to develop a level-of-effort estimate for documentation support. To start this process, provide as much of the following information as possible in an email to the NCI Leidos-CBIIT Technical Documentation Team:

  • JIRA issues explaining new features
  • URL to for the Development and/or QA servers
  • Functional requirements document, if available
  • Any other supporting documentation that describes how the features will be implemented
  • Development schedule
  • Budget available for technical documentation

...

  • 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.
  • The NCI Wiki Documentation is organized to make information within it is easy to find.
  • Wiki users are able to readily create new wikis and expand existing content, including new topics and new formats.

Documentation Feature Catalog

...