Page History

...

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 user documentation such as user guides, admin guides, and quick reference guides for release in formats including Confluence, Word, PDF, and PDFother formats. 
• Using Lucid Chart, Balsamiq, and other tools, design menus and information on web pages.
• Overhaul or update existing user documentation guides 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.
• Analyze 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 or wiki page 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.

• preparing team process documents.

How to Request Help

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

...

• 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

...