- Gather and Organize Documentation
- Collect all existing documentation.
- Out team will list each document in a spreadsheet with columns for:
- Manual
- Chapter
- Article Title
- File Name
- Type (Actionable/Foundational)
- Description/Notes
- Review and Split Content
The ScreenSteps team will perform the following:
- Review each document to determine whether it should be split up into multiple articles
- Split larger documents into smaller documents if necessary (often for documents over 40 pages)
- Determine if content needs to be separated – foundational information from actionable steps into different articles.
- Decide Import Method
- Identify articles that should be optimized with AI – typically for procedures (the AI will adds headings, lists, bolding and make it more readable).
- Identify articles that should be imported as-is – typically for policies or meticulously written documents that need to be imported verbatim.
- Collaborate and Finalize
- Review the import plan together.
- Adjust based on feedback and clarify any uncertainties.
- Import into ScreenSteps
- Import content that needs to be optimized using our Clarify Bulk Importer
- Import content that needs to be imported as-is using the DocX importer tool.
- This will generate manuals, chapters, and articles in ScreenSteps.
What is the Process We Follow to Import Existing Documentation?
Updated on