Latest posts by techwriter (see all)
- Hazards of Poorly Written Technical Documentation - December 26, 2016
- Get an ‘A’ on Your Next Research Paper With These 6 Simple Steps - November 28, 2016
- An Amazing and FREE Source of Magazines and Periodicals — ISSUU - November 25, 2016
Author-it, the integrated technical documentation publishing platform, recommends a folder management best practice that might help you in all your documentation projects as well.
Author-it recommends you organize your document content under the following three general folder categories:
(1) Shared Folders
These are the folders with content shared and used by all writers in a technical publishing group. They have the lowest security access. They include:
- TOC and Index page templates.
- Front and Back pages.
- Legal language.
- Disclaimer and disclosure text.
- Address, maps, and access information.
- Front matter content.
- Copyright language.
- Style guides.
- Company History or “About Us” information.
- Logos and commonly used icons.
(2) Working Folders
These are the folders that contain the actual project content that the writers are working on. You can organize them by client, department,product name, document type, project title, project type, and even years or time period. You can restrict the mid-level access only to those writers who are working on specific projects.
(3) Restricted Folders
They have the highest security access. These folders contain document templates, media objects, paragraph and character style definitions, font folders. Main folders Author-it uses are called Standards, Media Objects (called “Master Pages” in FrameMaker), Publishing Profiles, and Styles. Authors may read these folders but cannot edit them.