Page History

Wiki management and technical documentation support is available to CBIIT project teams and (non-CBIIT) NCI teams.

How We Can Help You

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. 

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

How to Request Help

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

• Your name
• Your organization (please spell out acronyms)
• Your 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 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

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.

Benefits of Involving the Documentation Team

Involving the documentation team in your project has many benefits, some of which follow.

• 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

The Documentation Feature Catalog demonstrates selected features available on the NCI Wiki. Ask us for help incorporating them into your documents. For exploratory purposes, this catalog also includes examples of these features implemented using a site generator.

{scrollbar:icons=false}

...

If you need to restrict a page to a group that does not exist or you do not find the right space for your project on the National Cancer Institute (NCI) Wiki, copy and paste the following questions into an email message, provide your answers, and send to Application Support.

The wiki team will create a space for your project if (a) there is no more general space in which your group can work or (b) your entire collaboration is extensive and must be restricted from editing by users who are not part of your work group. Otherwise the wiki team will assist you with creating pages in an existing space.

1) First Name: Requester's first name
2) Last Name: Requester's last name
3) NIH Username: User id of requester
4) Organization: Requester's organization (spell out acronyms)
5) Team or Project: Name of the team that will populate the space (spell out acronyms)
6) Name of the federal sponsor who will approve creating this space, LDAP group, or both; include contact information.
7) Title of your wiki home page: Title of your wiki; including the word "home" is optional; including the word "wiki" is recommended; spell out acronyms.
8) Anticipated number of separate topics: If this is a small number, you may be able to use a page family in another space if a logical one exists. You may indicate "not known."
9) Anticipated number of wiki pages: If this is a small number, you may be able to use a page family in another space if a logical one exists. You may indicate "not known."
10) How do you plan to use your wiki pages, for example, publish documents, provide tips and hints related to software: Describe your usage.
11) Who will be editing these pages? Your initial list of users who will add content and edit pages. Include each person's name, NIH username, and email address. If the person has no NIH username, include the person's organization and phone number. Note that once the space is established, people can obtain access by clicking the New Account link on the wiki.
12) Should these users be able to both add and remove content (it can be recovered), or add content only?
13) Do you want to restrict editing to just these people? Yes or No
15) Do you want to restrict viewing of the pages to just these people? Yes or No
14) If you answered "no" to question 13, do you want the general public to be able to view your pages? This means public search engines such as Google will index your pages. Yes, No, or Some pages
16) If you answered "some pages" to question 14, a team page will be created for you that is restricted for viewing to members of your LDAP group. Any "child" pages you add to that page will be restricted for viewing also. If you think this may not meet your needs, please tell Application Support.

For help finding an existing space that you can use and setting up your wiki pages (page family) or for additional information, contact Application Support.

Application Support, refer to the page DRAFT: Creating LDAP Groups, Spaces, and Page Families (restricted to the wiki administrators) for information on how to proceed when the information on this page is received from users.