A client that develops large software applications for military use had a labor-intensive, week-long workflow for generating requirements documentation. Requirements engineers cut and pasted content from Word and other sources into a database. Output generated from the database contained several inconsistencies and required significant manual reformatting. The client requested that we reduce the document generation time so that updated output could be distributed daily as a DITA-based Eclipse help plug-in. We developed a solution that includes the Ant build tool, macros for Microsoft Word and Open Office Writer, and XSL and Perl scripts. Issuing one Ant command starts the conversion process, and the client has an Eclipse plug-in within minutes. Read the two-page solution brief (PDF, 1.2 MB).

The publication department of a federal agency had a workflow in which authors submitted content in Microsoft Word, and compositors imported those files into Interleaf (QuickSilver). The PDF files derived from this content had no hyperlinks or bookmarks by default, and the HTML output required hours of cleanup to meet stringent Section 508 accessibility guidelines. We automated the conversion of the Interleaf-based information into FrameMaker and developed a process that used Blueberry Software's Filtrix software and custom FrameScript scripts. We created a set of unstructured FrameMaker templates with multiple master pages to accommodate the client's many page layouts. We also set up text insets to handle the redundancy of information in thousands of rate tables. The workflow we set up in unstructured FrameMaker 7 and ePublisher Pro enabled pushbutton production of Section 508–compliant HTML output and PDF output with bookmarks and live links. Read the two-page solution brief (PDF, 1.2 MB).

For a Department of Energy (DoE) laboratory, we assisted in the transition from unstructured to structured authoring for technical manual (TM) development and sustainment. First, we created unstructured FrameMaker 7 templates that followed military specifications (MIL-STD-38784). The complex templates featured automated security-level labeling and multiple master pages and table formats to handle lists of effective pages (LOEPs), authentication pages, safety notices, Illustrated Parts Breakdowns (IPBs), Group Assembly Parts Lists (GAPLs), and other specialized layouts. Using built-in template features and scripts, we also provided support for generated tables of contents, lists of illustrations, lists of tables, and numerical indexes. We converted 1000 pages of content into the new template. The conversion process used FrameScript to automate repetitive tasks. In the second phase of the project, we performed a content analysis and developed a customized structure for the organization's technical documents. We created all the files required to implement FrameMaker-based Extensible Markup Language (XML) authoring, including the element definition document (EDD), document type definition (DTD), and read/write rules for the structured application. Additional scripts automatically generated the list of effective pages and alternate parts tables. Finally, we wrote Extensible Stylesheet Language (XSL) transformation files that converted the XML output into HTML. Read the two-page solution brief (PDF, 1.2 MB).

A department within state government wanted to implement a structured publishing environment for their 100 maintenance manuals, which were authored in Microsoft Word. The department required print, PDF, XML, and HTML versions of the documentation. Also, end users needed the ability to search across all the manuals, but the department's current web-based search tool was no longer supported. In the short term, the department did not want to move writers from the current authoring tool, Word. We developed a customized process that converted the content from Word into unstructured FrameMaker files, and that content was then converted into structured FrameMaker files. Visual Basic and FrameScript scripts automated much of the effort in the two conversion processes. Because the department had basic formatting and structure requirements, we used our DocFrame structured authoring solution as the starting point for developing the structured workflow. We customized the default DocFrame components, including the EDD, formatting template, and the XSL transformations for HTML output. We also implemented a web-search solution based on Verity Ultraseek. We fully documented all aspects of the project and offered five days of training for authors and for the production specialists who handle the conversion from Word into FrameMaker, XML, and HTML. For now, authors will continue to create content in Microsoft Word, but they will eventually migrate to creating content in XML editors or structured FrameMaker. Read the two-page solution brief (PDF, 1.2 MB).

For a Fortune 500 company, we implemented a structured authoring workflow based on FrameMaker 7. We created a complex EDD, multiple formatting templates, and a structured application for round-tripping content as XML). We developed WebWorks Publisher templates as well as XSL transformations to create online outputs. We wrote more than 250 pages of documentation explaining the new structured authoring workflow, and we trained 45 employees on how to use the new system. As part of the training, we customized our Introduction to Authoring Workbook with exercises based on the company's structure. After creating a conversion process that included several FrameScript scripts, we converted more than 12,000 pages of unstructured legacy documentation in FrameMaker 5.5.6 to structured FrameMaker 7.

For a guidebook publisher, we consulted on a process for retrieving data from a database, creating a Maker Interchange Format (MIF) file from the data, and then applying a FrameMaker EDD and formatting to the file. The final output was structured, formatted FrameMaker files.

To facilitate the exchange of information between writers and developers, a telecommunications company wanted to upgrade their unstructured FrameMaker 6 documentation to structured FrameMaker 7 with XML Roundtripping We updated formatting templates, defined the structure for FrameMaker content, created a DTD compatible with the FrameMaker structure, developed a process to automate the conversion to the structured environment, and created a structured application for Roundtripping XML content.

For an insurance provider's policy documents, we created WebWorks Publisher templates and converted tens of thousands of pages from FrameMaker to HTML. The HTML output featured cascading style sheets (CSS), customized navigation, and embedded JavaScript. The WebWorks Publisher templates included numerous customized macros and regular expressions.

A Fortune 100 company was exploring structured authoring and XML. Our consultant met with the implementation committee to review the plan, identify risks, and offer recommendations on how to proceed.

A major accounting firm was implementing new communications software company wide and wanted a documentation package that explained how to install and use the new software. In six weeks, we developed an installation manual, two user guides, and two quick references. We also edited training materials developed by the company. The client printed 30,000 two-color copies of each manual.

Our staff wrote, edited, and produced Publishing Fundamentals: FrameMaker 7 (formerly published as FrameMaker 7: The Complete Reference), the definitive third-party reference on Adobe Systems' FrameMaker 7 software. The book covers both the unstructured and structured interfaces of FrameMaker. We also published five workbooks that are companions to Publishing Fundamentals: FrameMaker 7 . Each workbook includes a CD-ROM with animated screen shots and files for the exercises. We use the workbooks in our FrameMaker classes, and we offer them as self-study materials. Training providers also license the workbooks for their FrameMaker classes.

We developed print and online documentation for a suite of web-based applications. We designed the document templates, developed the books' outlines, and then wrote, edited, and produced more than 600 pages of user and administrator materials.

For a local start-up company, we created a full suite of documentation for an extensive C++ code library. The documentation included a reference manual, a programmer's guide, and a book that provided a detailed code example.

With only prototype software and minimal source material from developers, we developed a 150-page user guide and online help for a complex programming and code analysis tool. The online help featured 350 help topics and 350 context-sensitive topics.

In less than two weeks, we developed a complete manual for a web development tool from miscellaneous source documentation (a white paper, some draft documentation, and an outdated product spec). We designed multiple templates for PDF, HTML, and paper output. Our tasks included writing, editing, and indexing.

Scriptorium Publishing has provided production editing (composition) and indexing services for several trade-book publishers, including O'Reilly and Associates (Year 2000 in a Nutshell, Learning Perl/Tk, and others) and McGraw-Hill.

We took over a partially updated reference guide on database drivers, completed the writing process, then edited and indexed the manual. We also updated and streamlined the underlying FrameMaker templates.

We edited and restructured an online help system for a networking company, and provided a thorough analysis of the navigation problems in this help system. Using the client's style guide, we also copy edited the help.

We provided developmental editing for AT&T WorldNet Service Tour Guide, The Director 6 Book, The Comprehensive Guide to Corel WEB.GRAPHICS Suite, The Comprehensive Guide to FreeHand Studio 7, Microsoft Internet Explorer 4 Tour Guide, and several other books.

We edited 1,500 pages of class material (student and instructor guides) for an SNA integration tool.