SAIF Editing Crew: Update Page for Karen Smith

Back to SAIF Editing Crew

STATUS FROM PREVIOUS WEEKS

July 2, 2010

• Worked on the DITA Processing document and updated the SAIF Content Strategy document. Sent the SAIF Content Strategy doc to the ArB for an informal review.
• Wrote a DITA self-study course (mostly a list of DITA material to read) and sent it to a few people.

June 25, 2010

• Started working on the DITA processing paper.
• Discussed peer review plans (schedule and document format) at Thursday's ArB call. Created Word documents from the SAIF DITA source files for the authors to use in updating the text.
• Updated the graphics spreadsheet and posted it to our wiki.
• Received and installed the oXygen license, and created a signup sheet for others to use oXygen.
• Sent Steve Hufnagel some info about DITA as he's interested in using DITA for one of his two projects.

June 18, 2010

• Discussed design plans with Jane and Steve Manning begin_of_the_skype_highlighting     end_of_the_skype_highlighting of NCI.
• Attended two webinars: Learn About Single Sourcing and Find Out If It's Right for You and How to Successfully Plan and Manage a Move to XML.
• Discussed technical editing plans with Cecil Lynch who is writing the Information Framework document.

June 11, 2010

• Updated the SAIF DITA strategy document with new info about Component Content Management (CCM) systems, graphics, and a summary of the design considerations for the SAIF DITA document.
• Attended a webinar demo for the XDocs CCM. I think that having a CCM would be beneficial for managing files when more authors start contributing to the SAIF DITA document.
• Worked on the outlines for the DITA processing paper and SAIF book maintenance strategy.

June 4, 2010

• Attended a webinar about using the Resource Manager with HTML files with ActiveX controls. This highly-technical webinar was over my head.
• Continued testing the trial version of XMetal Author.
• Revised the outline for the DITA Processing Paper (titled "DITA Procedures and Training").
• Wrote a comparison of Oxygen and XMetal Author and included it in the email for Jane to forward to HL7 HDQ.

May 28, 2010

• Updated the XML Tool Considerations page with evaluation results for oXygen.
• Sent out an email with some questions about the audiences for the SAIF DITA book.
• Researched component content management systems that work with DITA. Two promising possibilities include Bluestream XDocs and x:Point by Sharepoint. XDocs plans to add support for oXygen this summer. XDocs seems to be the better choice as it is reasonably priced at $5000 plus the support fees. Alfresco Community Edition is a well-known open source Content Management System. However it will be more complicated to set up and good user documentation isn't available.
• One of the Open Toolkit developers asked me to create a DITA test case to verify a bug in the conkeyref code. This bug will be fixed in the next release of DITA Open Toolkit.
• Attended two webinars: 'Structured Content and Personalization; and 'Developing a Curriculum'.
• Started testing the trial version of XMetal Author.
• Recommended ordering oXygen licenses for HL7. Drafted an email that Jane will forward to HL7 headquarters.
• Wrote an outline for the DITA Processing Paper (titled "DITA Procedures and Training").

May 21, 2010

• Read the peer review comments and sent some recommendations for handling style issues and graphics to the ArB for consideration.
• The ArB will collate the peer review dispositions for the minor comments and pass them to me. Ron, Tony, and Charlie will meet to discuss these comments. They will discuss the process for handling major rewrites this Thursday.
• Compiled the list of DITA resources and sent it out to the group of people who are interested in learning DITA. This info will become part of the DITA processing paper eventually.
• Practiced the new DITA 1.2 functions using Oxygen.
• Published the Behavioral Framework DITA document to Word and sent it to John Koisch begin_of_the_skype_highlighting     end_of_the_skype_highlighting begin_of_the_skype_highlighting     end_of_the_skype_highlighting begin_of_the_skype_highlighting     end_of_the_skype_highlighting begin_of_the_skype_highlighting     end_of_the_skype_highlighting because the BF needs a lot of revision work.

May 14, 2010

• Met milestone 1 - Published the SAIF DITA document to PDF and XHTML to GForge. The Behavioral Framework information is now included in the DITA document. Nineteen BF graphics were converted to SVG, which greatly improved their readability.
• Asked the folks on the ArB listserve if they were interested in working with DITA and started compiling DITA-related information that is available online and in print.
• Practiced new DITA functions using Oxygen (keydefs and conkeyrefs). Practiced with using conditional processing for multiple audiences.
• I asked Woody Beeler if the Publishing group was interested in using DITA. They are considering using DITA for common definitions.
• Installed the RenderX PDF program and republished the SAIF DITA PDF. The PDF formatting looks nicer with more white space, better formatted "note" paragraphs, and improved table layouts. XEP supports index entries in PDFs.

May 7, 2010

• Completed adding the Behavioral Framework information to the SAIF DITA document.
• Revised the description of the SAIF triptych graphic in the ECCF DITA and Word documents.

April 23, 2010

• Started converting the Behavioral Framework info to the DITA format.
• Wrote a new description of the SAIF triptych in the ECCF DITA section.
• Revised the simplified SAIF triptych graphic with Jane's suggested revisions.
• Updated the DITA Content Strategy document, file name conventions, and created workflow diagrams for training.
• Tested the trial version of oXygen (which expires on April 27th).
• Worked with my husband on content management spreadsheets for tracking changes to the DITA topics and graphics.

April 16, 2010

• Created a simplified version of the SAIF triptych graphic for the Executive Overview and reworked Ron Parker's WI graphic so that I could save it in EMF format. Discussed graphics with the ArB on Thursday. The ArB liked the simplified triptych graphic for the executive overview. Ron and Charlie were going to get together to discuss the new WI graphic. The ArB wants "CDA R3" added to the original SAIF triptych graphic, which is in the ECCF section.
• Obtained pricing and licensing information for oXygen and XMetal Author. Because HL7 is a standards development organization, we can use the RenderX XEP software for freeto create PDFs from the DITA source files. I asked Karen Van Hentenryck to obtain three XEP licenses. If we purchase oXygen, we should get the Enterprise version that can be integrated with a database or content management system.
• Created a spreadsheet for testing the links in the XHTML output.
• Drew concept maps that show the work flow for DITA conversion and DITA editing. These cmaps will go into the DITA strategy document.

April 9, 2010

• Tested the trial version of oXygen.
• Incorporated Ron Parker's review comments in the DITA version of the Executive Overview and Introduction. Rewrote the executive overview using the SAIF Snapshot as a base. Built XHTML and Word outputs, tested links, created a peer review draft of the Intro.
• Worked on a content management spreadsheet for tracking changes to the DITA topics over time.

April 2, 2010

• Ron separated out some of the material in the SAIF Intro into three appendices. He edited the Executive Overview and Introduction sections of the DITA document. He removed the ArB-centric language in the Intro and added more details to the overview sections for the ECCF, BF, GF, IF, and Implementation Guide. I thought that it would work best to shorten the Executive Overview and use the material from the SAIF Snapshot as the source, and Ron agreed.

• Added the graphics back into the Word document and updated the cross-references. I created a "diff" file of the Word output document, reorganized the Intro ditamap structure to move the supplementary material into the "appendix," and started updating the DITA source files with Ron's review comments. Also started practicing with the trial version of oXygen.

• Explored the possibility of simplifying the SAIF triptych graphic for the executive overview. The original version would work fine in the ECCF section as it is geared towards the enterprise architect.

• Started working on the DITA topic content management spreadsheet.
• Craig started working on the graphics spreadsheet.

March 26, 2010

• Revised metadata spreadsheet.
• Experimented with using Adobe Acrobat to compare two PDF files. We could use this method to compare changes in between releases.
• Created a Gantt chart to track project schedule and activities. See SAIF Project Tracking.
• Tested the DITA test builds for bad links and formatting problems. Ran DITA to Word and DITA to single XHTML test builds.
• Stored the completed graphics for the graphics library in the SVN saeaf-graphics directory.

March 19, 2010

• Created a spreadsheet for tracking work flow from the Word documents to the DITA output. I will send out snapshot pages to Karen V. and the ArB for each review milestone.
• Created a spreadsheet for tracking DITA build versions and established a file naming convention for the zipped build files.
• Created a spreadsheet for tracking phase 2 status.
• Created a new wiki page, SAIF Project Tracking, for people to view the various spreadsheets.
• Renamed the DITA filenames and text (SAEAF to SAIF).
• Worked on the metadata spreadsheet and updated metadata in the DITA files.
• I sent Ron Parker the DITA version of the SAIF Executive Overview and Introduction to edit. We discussed the major editorial issues with the Intro (too long, emphasis on SAIF as an EA solution rather than as an interoperability framework).

March 12, 2010

• Talked with Ron Parker about posting the SAIF XHTML and PDF outputs on the HL7 web site.
• Re-posted the BF and ECCF peer review documents on GForge.
• Started working on several tracking spreadsheets.

March 5, 2010

• Updated the SAIF review schedule with the new peer review date.
• Completed editing the Behavioral Framework document and sent out the line-numbered PDF on March 4th. The BF is now ready to be converted to DITA and included in the SAIF DITA document.

February 22, 2010

• Created and posted the SAIF review schedule for phase 2
• Wrote a document describing the SVN directory structure used to store the SAIF DITA project source and output build files.
• Incorporated Charlie's comments and renamed SAEAF to SAIF in the graphics, and created a PDF version of the SAIF DITA book with line numbers for the peer review.
• Edited the SAIF triptych graphic and associated text. Worked with Craig on creating the SVG version of this graphic for the DITA document.

SVN DIRECTORY STRUCTURE FOR SAIF DITA PROJECT

Attached is the SVN directory structure used for the SAIF DITA project:

• File:Saeaf dita project directory structure.pdf