Page History

...

• Write user's guides for release in formats including Confluence, Word, and PDF. 
• Overhaul or update existing user documentation for a new release.
• Write scripts for and record explainer videos about software usage.
• Write online 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.
• 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.

Wiki Management Tasks

The documentation team can help make a project successful by performing the following tasks and others.

• Remediating wiki pages for Section 508-compliance
• Wiki restructuring (creating standard headings on home page, grouping items such as status reports together, and so on)

(If you want to create or update an LDAP group and/or wiki space, contact NCIAppSupport@nih.gov.) 

Website Design Tasks

The documentation team is adept at organizing complex information for clear presentation in a website. Using Lucid Chart, Balsamiq, and other tools, we can design menus and information on web pages.

How to Request Help

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

...

Upon request, the documentation team can create a detailed documentation plan to estimate the time required to complete the work, confirm the scope of the project, and agree on deliverables. To improve the plan's accuracy, send as much of the information above as possible to the technical writer as soon as possible.

Wiki Management Tasks

The documentation team can help make a project successful by performing the following tasks and others.

• Remediating wiki pages for Section 508-compliance
• Wiki restructuring (creating standard headings on home page, grouping items such as status reports together, and so on)

(If you want to create or update an LDAP group and/or wiki space, contact NCIAppSupport@nih.gov.) 

Website Design Tasks

The documentation team is adept at organizing complex information for clear presentation in a website. Using Lucid Chart, Balsamiq, and other tools, we can design menus and information on web pages.

Benefits of Involving the Documentation Team

...