the perfect conversion framemaker to dita in 365 days：完美的转换framemaker dita 365天

ThePerfectConversion:FrameMakertoDITAin365DaysYasEtessamXMLArchitect,TechnicalCommunications,VMwareLauraBellamyInformationArchitect,TechnicalCommunications,VMwareApril2009YourPresentersTodayYasEtessam,XMLArchitectDesignsanddeliversstandardsbased,globalizationreadycontentdevelopmentenvironmentsXML/SGMLexpertContributortotheOASISDITAstandardYourPresentersTodayFocusoninformationstrategyandarchitectureforenterpriseproductsDITAconversionprojectmanagerandexpertLauraBellamy,InformationArchitectAboutVMware&VirtualizationGloballeaderinvirtualizationsolutionsPubliccompanywithmorethan5,500employeesworldwideVirtualization:SeparatesoftwarefromhardwareRunmultipleoperatingsystems&applicationssimultaneouslyonasinglecomputerDraganddroptomoveapplicationsfromonemachinetoanother2008ProductLine•VMwareVirtualCenter•VMwareConverter•VMwareCapacityPlanner•VMwareSiteRecoveryManager•VMwareVirtualDesktopInfrastructure•VMwareACE•VMwareLabManager•VMwareDRSwithDPM•VMwareHighAvailability•VMwareConsolidatedBackup•VMwareStorageVMotion•VMwareVMotion•VMwareUpdateManager•VMwareESXServer•VMwareESXServer3i•VMwareVirtualSMP•VMwareVMFS•VMwareServer•VMwareWorkstation•VMwareFusion•VMwarePlayerOur365-DayStorySuccessstoryConversionofanenterpriseproductlibraryFromunstructuredFrameMakerto5000+DITAtopicsConversionduringanactivereleasecycleSinglesourcinghelpandmanualsWritingandproductionteamhadnoDITAexperienceConversionChallengesLegacycontentinFrameMakerconvertedtoVMwareDITA1.1XMLConvertingcontenttakesplanning,teamwork,andacommitmentofresourcesVendorselectionQualityconversioniskeyTurnaroundtimeDomultipletestrunsofthesamecontentwithdifferentvendorsThemovetoanewauthoringmethodologyrequiresaculturalshiftlTrained45writersConversionTechnicalRequirementsPrerequisitesUnderstandthetargetDITAdatamodelEnsurethatthepublishingtoolsarereadytosupporttheconvertedcontentConversion:In-houseconversionversusoutsourcingIn-houserequirestechnicalknowledge,extensiveresources,toolssupport,andQALeadingaerospaceproducerhadtheirstaffconvertcontentwithMif2Go,staffinghourscostover60KTestdriveconversiontoolsSendovercontentandseewhatyougetbackNotallconversionsareequalVendor#1NohierarchyintheDITAmapAlltopicsinthesamefolderConversionthatwouldonlyworkforHelpoutputsbutnotforPDFoutputs(<topicgroup>)Conversionthatdidn’tfilloutcriticalpublishingattributesVendor’slackofexperienceandDITAreferencablecustomersVendor#2DITAmaphierarchyWillingtoworkwithourfolderandfilenamingrequirementsRecognizepublishingandconversionarelinkedCosteffectiveWehelpededucatethemonDITADITARequirementsStackUnicodeencodingXMLDITA–MapsandTopicsDITAElementMappingandSpecializationsToolSpecific–Frame,XMetaL,WebWorksConditionsEncodingRequirementsLayinggroundworkforlocalizationUnicodeUTF-8isthebesttargetencodingByteOrderMarksXMLencodingdeclaration<?xmlversion="1.0"encoding="UTF-8"?><!DOCTYPEconceptPUBLIC"-//VMWARE//DTDDITAConcept//EN""vmbase.dtd">XMLRequirementsWell-formedandvalidDTDshouldbeclearlyidentifiedPublicIDsaregood: <!DOCTYPEconceptPUBLIC"-//VMWARE//DTDDITAConcept//EN""vmbase.dtd">SYSTEMIDsarebad: <!DOCTYPEconceptSYSTEM“../dtd/vmbase.dtd">DITARequirementsWhichversionofDITAwillyoubeusing?Specializations?Bookmap?DITAmapswith.ditamapextensionDITAtopicswiththe.xmlextensionOnetopicperfileDITAmaphierarchyCorrectinformationtypes:concept,task,reference,andglossaryDiscussfolderstructure

DITARequirementsElementMappingConsistentuseofFrameorWordtemplatesiskeyEveryFrameMakerstylewillbemappedtoeither:AtargetDITAelementNothing(deprecatingthestyle)MaptothebestsemanticelementMapto<uicontrol>ratherthan<b>Avoidmappingto<ph>Ifcontentisambiguousormapsfromonetomanypossibilities,conversionshouldmaptoanelementthenwrapthecontentwith<required-cleanup>Example:Monospacecouldmapto<codeph>or<filepath>DITARequirementsElementMappingTableWarningNotestyle<notetype=“warning”>Boldstylewith>inbetweenwordsFile>New<menucascade><uicontrol>File</uicontrol><uicontrol>New</uicontrol></menucascade>“Optional:”stringIfinsideastep:<stepimportance=“optional”>DeprecatedstylesNotaggingDITARequirementsElementMappingTableCrossreferencesstartingwithhttp://<xrefscope=“external”href=“http://”format=“html”>Internalcrossreferences<xrefscope=“local”href=“installing.xml”type=“concept”>Italicsstyle<required-cleanup>MonospacedstylethatcanmaptoseveralDITAtopics<required-cleanup><filepath>C:/xyz/foobar.xml</filepath></required-cleanup>DITARequirementsDITAMapsTopicreferencehierarchymustbemaintainedLargedeliverableswithmultipleauthorsshouldhavesubmapsNicetohave:navtitlewiththetopictitlepulledinMaptothecorrectelements:<topichead>vscontainertopicsIndextermsTakeadvantageofconversiontoadoptL10NbestpracticesMoveindextermsto<prolog>OrmoveindextermstothestartoftheblockelementsDITARequirementsConditionsMapFrameconditionstoproduct,platform,oraudienceFramecondition:ESX_Embedded

DITAcondition:

product=“embedded”Conrefs/TextInsetsSpaghettiwarning!CommentsFrameconditions:CommentDITAcomment:<draft-comment>ToolSpecificRequirementsExample1:MaintainFrameMakerchangebarsConvertedtoXMetaLrevisionmarksExample2:WebWorksTopicAliasmarkersDITA:

<othermetaname=“TopicAlias”content=“xyz”/>TechnicalGotchasPublishingNotenoughtobevalidXML,needtobeabletopublishwiththeDITAOpenToolkitandavoiderrorsandwarningswherepossibleCrossreferencecleanupNoautomatedwaytocreatereltablesManualtaskWhitespaceDeleteemptyparagraphsandextraspacesAutomaticnamingFilenamingandfoldernamingWindowslimitsonpath/foldernamesConversionProcess–ContentWorkshopsWritersandeditorsholdDITAContentWorkshopstopreparefortheconversionprocessSchedulethemeetingfor1monthbeforethescheduledconversionReviewasampleofadeliverableina1-2hourmeeting.LookforitemsthatarenotsupportedinyourelementmappingtableIdentifycontentthatisnotorganizedbytopictypeIdentifycontentthatdoesnotstandaloneUsethismeetingtodiscusstheconversionprocesswiththewriterConversionProcess-PreconversionCleanupWritersimplementpreconversioncleanupoftheFMdocumentsto

ensureDITA-readystructureandconsistencyFollowtheFrameMakertemplaterulesMinimizecontentOrganizecontentbytopictypeWritemeaningfulheadingsandtitlesReviewandstandardizeconditionaltextStructuretasksforDITAReduceinternalcrossreferencesandcitationsRemoveexternalcrossreferencesRemovescreenshotsConversionProcess-GraphicsGraphicsteamconvertsgraphicstoSVGformatWriterswillneedtoproducenewalttextforeachgraphicConversionProcess–SubmitforconversionDeliverFrameMakerSourceScheduleconversionshipmentswiththevendorProductionsendstheFrameMakerfilestotheconversionvendor.Max10dayturnaroundofcontent

InformationTypingConversionvendorsendsbackaspreadsheetWriterverifiesthetopictypes,chunking,andfilenamesinthespreadsheet

PostconversionCleanupandQA

ProductionreceivestheXMLandstartspostconversioncleanupandQAProductionpublishestheXMLtoPDFandWebWorksProductionaddsanyspecialmetadataandsetsupthelinkrelationshipsforhelpProductionstoresthecontentinarepositoryandinformsthewriterWriterscompletepostconversionitemsandtakefinalstepstocreatesolidDITAcontentConversionProcessGotchasDonotintroducenewFMstylesorconventionsNonewstylesNospecialheadings,suchas“Prerequisite”

VerifyFMfilesbeforeconversionCheckthenestinglevelsoftopicsRemoveanystylesnotsupportedinyourelementmappingtable

DocumentpotentialreuseandrelatedlinkingUniqueopportunitytoevaluateeverytopic

SpellcheckbeforeconversionYourXMLeditormightnothavemap-basedspellcheck

PreparewriterstobewithoutcontentInformationArchitectureStrategyKnowyourinformationGatheranaccuratepictureofwhatinformationyoucurrentlyhavetounderstandelementmappingrequirements,expectedtopictypes,templaterequirements,andpotentialreuseDefinetheconversiongoalsWhatistheprimarydriverfortheconversion:savetranslationcost,improveuserexperience,increasereuse?Doyouneedquick&dirtyorcanyoufocusonquality?DefinedocumentationstandardsInformationshouldmatchfuturecorporatedirectionandgoalsDoyouneedtomeet/exceedindustrystandards?PostconversionDITAgoalsIncreasecontentreuseImplementthereuseidentifiedinFMfilesDoareuseanalysisduringpostconversionStartreusingentiretopicsandconrefingpiecesofinformation

TaskmodelingLeavethesequentialbookmodelbehindReorganizeconvertedcontentintoapropertaskflowImplementcollection-types

WorktowardconsistencyTraininganddocumentationEnd-usertrainingCreateatrainingplanWhowillcreatethematerials?Givethetraining?

GuidelinesTheDITAlanguagerefmightneedtobemodifiedtopresentonlythetagsthatyousupportDITAintroducesnewfeatures.Decidehowyouwanttousethesefeaturesandeducateyourteam

ProcessdocumentationWritersneedinstructionforhowtobuildoutput,implementcompanystyleandguidelines

TemplatesIncludedescriptivetextinnewtemplatesandboilerplatecontent(Preface,Appendix,Glossary)ToolsdevelopmentandsupportBuildingnewtoolsLetthecontentneedsdrivethetoolsdevelopmentSupportingtheteamAllocateresourcetosupportingnewDITAusersCreateasupportteamanddefineacommunicationstrategywhereyoucanquicklyrespondtoquestionsDecidehowtorollouttoolsupdatesandprovidecontinuingeducationEvaluatetheendresultCodereviews

EnsuretaggingqualityandconsistencybyreviewingtheDITAfilesGivewriters1monthtolearnandworkwithcontentCommunicatetaggingerrorsandlookforpatterns

ChecktheoutputMightneedtoadaptstylesheetsinresponsetonewDITAfeatures

GatherfeedbackAskendusersaboutthenewexperience:technicalreviewers,betacustomers,trainers,etc.ProjectManagementStaffingScopingBudgetingManagingStafftheprojectHireexpertsItistoodifficulttolearnDITAwhenyoustartaconversionprojectIdentifytheskillsthatyourteamismissingWhatcanyoutrainforandwhatdoyouneedtooutsourceExpectstaffrolestochangeWhatnewresponsibilitieswillexistingstafftakeon?Howcanyouuseexistingstaffinnewways?UnderstandthetimedemandsonexistingstaffwhoarenewtoDITAScopetheprojectCreateapilotteamDefinethepilotrequirementsLocalizationSizeandcomplexityReleaseschedulePersonalattitudeandworkingstyleDocumentexpectationsandgoalsLimityourselfatfirstEasytoaddmorelaterEvaluatethepilotresultandimprovetheprocessCreatearolloutplanBudgettheprojectGetcostestimatesfro