This wiki has undergone a migration to Confluence found Here
<meta name="googlebot" content="noindex">

SAIF Editing Crew: Update Page for Karen Smith

From HL7Wiki
Jump to navigation Jump to search

Back to SAIF Editing Crew

STATUS FROM PREVIOUS WEEKS

Dec 18

  • Worked on the PowerPoint presentations for the DITA training.
  • Completed the fourth DITA training session and discussed the SAIF DITA project status with Publishing.
  • Wrote the homework assignment for day 4.
  • Posted presentations, homework assignments, and videos on GForge.

Dec 11

  • Worked on the PowerPoint presentations for the DITA training.
  • Completed the first three training sessions with two more remaining.
  • Created eleven demo videos.
  • Uploaded the narrated PDFs of the presentations, videos, and DITA homework assignment to GForge.
  • Copied the BF updates from the Word document into the SAIF DITA files (but didn't finish). I set aside the DITA work to focus on the SAIF DITA training and knowledge transfer.
  • Andy Bond updated the SAIF Intro with the few remaining peer review comments.
  • Charlie agreed to look over the ECCF document by the time my contract ends.
  • I am to hand off the Behavioral Framework document to Ron Parker and Charlie Mead begin_of_the_skype_highlighting     end_of_the_skype_highlighting when I'm all done copying my updates to the SAIF DITA files.
  • I haven't received any glossary entries from Wendell Ocasio yet.

Nov 23

  • I finished updating the DITA files for the SAIF Overview and Introduction, started updating the DITA files for the Behavioral Framework, and added a new DITA file containing Steve's executive overview.
  • I also have been working on the training PowerPoint presentation.
  • Craig did some work on graphics and we discussed ideas for the training presentation as I am likely to need his help with voicing for me at the sessions.
  • Andy Bond volunteered to finish updating the SAIF Intro with the remaining peer review comments. The ECCF and BF documents are now in Charlie's hands.

Nov 12

  • Updated DITA processing paper with info about new oXygen 12 functions and guidelines for publishing to different output formats.
  • Sent out DITA training and knowledge transfer plan to Jane, Don, and Wilfred. Also sent the oXygen license key to Don and Wilfred.
  • Discussed the high-level structure of the SAIF TOC with Jane. Each sub-document will have similar core h2 headings and additional h2 headings can vary.
  • Started updating the SAIF DITA files with the peer review updates that I made to the Word documents. I completed step 1 (updated the ditamap files) and added the new high-level topics for the GF and IF docs to the ditamaps.
  • Worked with Craig on a new design for the 3D ECCF graphics and sent one to Steve Hufnagel and Charlie Mead begin_of_the_skype_highlighting     end_of_the_skype_highlighting begin_of_the_skype_highlighting     end_of_the_skype_highlighting to review. The 3D ECCF spec stack diagram was rotated 90 degrees to have the same orientation as the ECCF table. Although Steve liked the new design better than the original one, he still found the 3D graphics confusing and preferred the table graphics. He also provided some suggestions for improving the 3D graphic. He had some issues with the localization strips, as did Lloyd McKenzie and Mead Walker during the peer review. This issue will be for Charlie to address.

Nov 5

  • Finished revising the BF and sent it to Cliff for review.
  • Converted six ECCF graphics to SVG format with six more to go.
  • Updating DITA processing paper with new oXygen 12 functions (especially the Condition Set Profiling feature).

Oct 29

  • Finished incorporating peer review comments in the ECCF and BF Word documents.
  • Finished updating all three peer review spreadsheets and posted them to GForge.

Oct 22

Last week, I did the following work:

  • Incorporated peer review comments in the ECCF and BF Word documents.
  • Created an outline of the SAIF table of contents.
  • Reached agreement with the ArB about including Steve's executive summary in the SAIF DITA document.
  • Sent Wendell Ocasio 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 copies of the Intro, ECCF, and BF documents, and an updated version of the SAIF glossary.

I reached milestone 3 on October 11th and the following are my milestone 3 accomplishments:

  • Wrote the DITA processing paper and sent it to Don Lloyd for review. This document includes procedures for working with DITA, HL7 SAIF documentation procedures, and a DITA style guide.
  • Updated the SAIF DITA strategy document.
  • Compiled a glossary of SAIF terms. These terms were reviewed at the Cambridge WGM. Wendell Occasio and Nancy Orvis will work on reconciling the SAIF terms with the HL7 glossaries.
  • Updated the SAIF executive summary and Intro (in Word format) with the peer review comments and sent it to Ron Parker.
  • Currently updating the ECCF and BF (in Word) with the peer review comments.
  • Renamed the SAIF SVN directories (changed saeaf to saif).
  • Expanded the preface section in the SAIF DITA document.
  • All the Intro and BF graphics are now in SVG format.

Oct 15

  • Incorporated peer review comments in the Behavioral Framework document. I was up to page 25 (core framework concepts).
  • Cliff completed updating the ECCF document with the "easy" peer review comments.

Oct 8

  • Rewrote the BF Introduction as it was poorly organized and incorporated peer review comments.
  • The Intro and BF graphics are now in SVG format. The ECCF graphics haven't been converted to SVG yet.
  • Expanded the section on highly informational systems in the Intro to show how they relate to Working Interoperability.
  • Updated the line numbers in the peer review comment spreadsheet for the ECCF comments.
  • Touched base with Wendell Occasio about the SAIF Glossary and sent him links to the latest SAIF documents.

Oct 1

  • Completed the DITA processing paper and sent it out for review. Also added links to this document and the quick reading list to the Project Tracking page.
  • Chatted with Don Lloyd about DITA and his publishing work.
  • Completed updating the SAIF Intro with the review comments and sent it out to Ron and John for their review.
  • Renamed SAEAF to SAIF in SVN subdirectories (except for the top-most directory).
  • The SAIF Glossary will be reviewed at Cambridge.
  • Started reorganizing the Behavioral Framework introduction as it was too long and complex. Also, the introduction actually contained three different topics -- what is the BF, where to find info in the BF document, and how the BF fits in with SAIF.

Sept 24

  • Sent the list of SAIF glossary terms to the internal ArB for review on 9/23. At my request, the ArB agreed to review the glossary at Cambridge.
  • Completed updating the SAIF Intro Word doc with the peer review comments (except those assigned to others) and sent it to Cliff for his review.
  • Updated four SAIF concept maps with reviewer comments and made the style consistent throughout.
  • Worked on DITA processing paper.
  • Upgraded to oXygen 12.

Sept 17

  • I have finished writing the DITA processing paper except for the style guide at the end. (When I'm all done, I'll send it out for review to Don Lloyd and others who are interested in using DITA.)
  • Met with Ron Parker and Cliff Thompson 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 begin_of_the_skype_highlighting     end_of_the_skype_highlighting to discuss plans for updating the SAIF Intro, ECCF, and BF with the peer review comments, based on the 8/23 comments spreadsheet.
  • Cliff Thompson and I have been working on a greatly enhanced SAIF glossary, which I will send to the ArB for an internal review on 9/23.
  • I started updating the SAIF Intro with the peer review comments. (Cliff and I hope to have a draft ready by 9/23.)

We also will be updating the ECCF and BF with the agreed-upon peer review comments. Our goal is to reduce the number of comments by 80%, then let the ArB authors handle the tough comments.

Sept 10

  • Worked on DITA processing paper. I'm almost done except for the Information Architect Workbench procedure, graphics procedures, and the DITA style sheet. Cliff read it over the weekend and had a few minor comments.
  • Cross-referenced and updated the line numbers for two ECCF peer review spreadsheets for Charlie Mead.
  • Worked with Cliff on plans to incorporate peer review comments into SAIF documents. Fixed formatting issues in comments spreadsheet.
  • Expanded the preface section in the SAIF DITA document and moved the executive overview section into its own ditamap file.

Aug 13

  • Worked on DITA processing paper.
  • Met with Pat Van Dyke of the EHR Tooling group, demonstrated oXygen and DITA to this group, and successfully converted an EHR table from Word to Excel to XML to DITA, and documented the process in the DITA processing paper (Aug 4-5).
  • Cliff Thompson forwarded an email from Dave Carlson of the Open Health Tools project who was looking for documentation on creating Implementation Guides using DITA. I sent him information on DITA procedures.

July 30

  • Created the first page of the EHR FM table and created some demo output to show the EHR Tooling group. (The EHR group is considering using XML or DITA as their source document for the EHR tables. They want to identify a process or set of tools to track compliance and traceability of the models.)

July 23

  • Finished editing the first draft of the Information Framework document. Cecil will rewrite and resubmit the document.
  • Attended the EHR work group meeting. They are considering using DITA for their project.

July 16

  • Completed milestone 2 and updated the status spreadsheets.
  • Attended a Webinar on customizing content with DITA conditional text.
  • I went over the SAIF DITA strategy document with Steve Manning and also with the ArB on Thursday. The ArB approved of the strategy document as an interim work in progress.
  • Started editing the Information Framework document and read some background material.

Summary: Steve wanted to know which PDF rendering program I was using (XEP). He's used XEP and Antenna House Formatter. XEP is faster and Antenna House has more customization options.

Steve asked me whether the topic owners did the DITA authoring themselves. I'm doing all the DITA authoring at this point. He suggested creating DITA topic files (with headings and structures) for the authors to fill out. This is a good idea.

Then we discussed reviews. They're considering using Word for external reviews (which we at HL7 already do) and XMetal Reviewer for internal reviews.

Steve's team will be using a Component Content Management (CCM) system to handle the files, reuse, and links. They have too many contributors to track everything manually. A key function for them will be "where-used" reporting so we can know where topics are being reused. It'll be nice to have the CMS manage the links too!! At HL7, we are using SVN and spreadsheets for our CCM system. One of my spreadsheets tracks content reuse.

Steve has not yet decided on a DITA editor (either XMetal or oXygen).

I will send Steve a zipped copy of the ECCF DITA files and associated graphics. Already sent him the ECCF Word file.

July 9

  • Worked on the DITA processing paper and started the DITA training PowerPoint.
  • Updated SAIF CCM spreadsheets for the DITA topics. For the latest spreadsheets, see the SAIF Project Tracking page.
  • Created the ditamaps and directories for Governance Framework, Information Framework, and Implementation Guide, and rebuilt the SAIF DITA document to PDF and XHTML.

July 2

  • 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

  • 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

  • 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

  • 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

  • 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

  • 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

  • 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

  • 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

  • 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

  • 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

  • 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

  • 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

  • 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

  • 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

  • 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

  • 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

  • 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: