Technical Writing Services
Our Technical Writing Program provides the framework for documenting detailed OIT procedures at NC State University.
Scroll down for details.
For details about the many benefits your team can realize, see the Summary of Technical Writing Program.
Options
The OIT Technical Writing Program from Security and Compliance (S&C) offers the following options for OIT to use our technical writing services:
- Option 1: Request a writer
- Option 2: Develop your own procedures
Option 1: Request a Writer
When choosing this option, you are asking for S&C’s technical writer to develop your written procedures.
Using this option, you dedicate a Subject Matter Expert (SME) to provide initial content, review the writer’s work throughout the document development process, and provide feedback to ensure technical accuracy and completeness.
For details, see the following:
- To request this service, use the Technical Writing Request Form.
- For a matrix of roles and responsibilities, see the OIT Tech Docs RACI spreadsheet.
- See also the “Related Documentation” section at the end of Summary of Technical Writing Program.
Option 2: Develop Your Own Procedures
When choosing this option, your SME will choose a template to develop the documentation.
For details, see the User Guide — Using S&C Templates to Document OIT Technical Procedures.
NOTE: If your documentation includes procedures interacting with software, you will choose TEMPLATE 2 or 3 (for the inclusion of screenshots).