Structured Authroing: Enterprise Acceptance, Education, and PM?

After some unusual experiences with a recent structured FM project, I wanted to turn to a community of peers to learn if others have experienced similar situations and what advice you might offer, if you have. Here is the background of the situation:
I was hired by a high-tech company to update a techincal manual almost two years ago. The company had about 6 to 10 very long internal engineering and customer-facing documents, almost all of which had been managed with LaTex for years. In an attempt to improve their documentation process, their former graphic designer/technical writer had migrated the documentation for their flagship product to InDesign. That decision wasn't too practical, as it was a 200+ page hardware and software user guide for a telecom device, something not well suited for a layout program. After taking care of their short-term needs with updates in ID, I explained the benefits of structured authoring to the project supervisor and subsequently my contract was extended to migrate all of their documentation to structured FM. This process went extremely well, largely because I was given a great deal of autonomy due to my experience in such projects.I wrote a custom EDD and templates that could be applied to all documentation and successfully migrated their legacy documents.
After that phase of the project ended, though, I found it very hard to properly manage their documentation needs, largely because of their ignorance and unwillingness to understand some of the basic needs related to structured authoring. I had made a concerted effort to educate them about structured FM all throughtout the migration, but my overworked supervisor considered my detailed reports as "too much information." Somewhere along the way, I believe she came to think of structured FM as a magic bullet of some sort and my explanations became misinterpreted as some sort of waffling, incompetence, or an attempt to pad hours. Really what my requests consisted of were nothing more than a development cycle that preceeded editing, a period that would allow me to manage any EDD work. It should be noted that the document in question was updated in parallel with a software release schedule of approximately 6 months and the management of this document alone was a full-time job for my predecessor. I reduced this process to a cycle of approximately 2 to 4 months per year, largely through the benefits of structured authoring that I don't need to detail here. Problems really began occurring when sales people and management started requesting last-minute, wholesale changes to the documents only weeks before deadlines, changes which required significant changes to the EDD. In my last deadline I received 200 marked-up pages of graphic and content changes two weeks before deadline while I was finalizing release notes and last-minute work. To get these changes done, I ramrodded them through and destroyed the structure of the documents and then had to go back and fix them thereafter. More specifically, I requested two weeks to rewrite the EDD and reauthor the 200+ page document and was confronted with increduility that it could takes so long -- and it was demanded that I complete it in a matter of days. I was actually told to make the "structure" of the document simpler, because "it's just a simple XML file after all" This company obviously had larger problems with their production processes and I was given no authority to change them, but I still find it difficult to grasp what I came up against in terms of acceptance, education, and management realted to structured management project requirements, especially when I explained it in such clear terms.
Certainly I would like to hear from anyone who cares to comment on the details of my experience. But more universally, I wonder if such obstacles are commonplace in your experience -- this was the first time I have come up against them. Also, when it comes to project estimation related to writing EDDs and doing development work, could you share your methodologies for coming up with timelines?
Thanks in advance,
Douglas

Just these brief insights into your own experiences have confirmed to me that I managed the work properly and the issue had everything to do with shortcomings in processes and a lack of understanding regarding structured FM.
I used to work as an editor at an IT trade publication and no matter what enterprise technology I was covering, the experts/vendors in the field who discussed IT implementations for varying companies would always underscore how the success of a project hinged upon the client's understanding and participation in that implementation. I think that adopting structured FM is no different in that regard. Moreover, if a lot of FM users have trouble wrapping their head around the concept of structured authoring and it takes years for a FM developer to really build serious chops, it only stands to reason that someone whose depth of experience with publishing is MS Word will probably have trouble digesting the big picture. Also worth noting is that, at least in my case working in the IT industry, are often IT nerds, who are frequently brilliant but won't always readily admit when they don't understand something.
This whole experience has given me a different perspective on what I need to do to evangelize and educate on structured authoring in future projects. The demands that I was given were so ludicrous in this project that I described, that I resigned after delivering documentation for the software release. Sad to have had to have done it for these reasons of ignorance rather than issues with the quality of my work, but it underscores how problems with adoption alone can impact a project.
A funny anecdote related to this aftermath...so simple does the project manager think structured FM that I learned she tasked the company's graphic designer with ownership of these now mangled templates/EDD - he has never even opened FM. Given the fact that even as an experienced FM user I am constantly confronted with bugs, difficulties, and frustrations with things like propagating formatting, TOC generation, or book numbering, I can only imagine what this guy is going to face. Ultimately, though, I think it will force them to confront the reality of structured authoring. Maybe this should become my horror story in future projects to underscore the importance of a holistic approach with this work. Sometimes you learn the most from such bad experiences.

Similar Messages

  • Reg IS- HER (Higher Education and research)

    Hi all,
    I need to integrate the "Higher Education and Research" module of SAP into Enterprise Portals.
    Can anyone please let me know how to go about doing it.
    I searched for a Business package for the same but could not find one.
    Thanks in advance.
    Regards,
    Vivek

    Hi Vivek,
       I don't know anything about HER but if there isn't a business package available, you can go a couple of ways.  First way is to use the Webgui in ITS or the WebAS on your HER system to web-enable the transaction. 
    The second would be to write code (e.g. Java, etc) to call the function modules and return the data in a web enabled format.
    I suggest the first way to try it out quickly.
    Hope this is some help
    John

  • Does anyone have trouble serializing the enterprise version-education?

    Does anyone have trouble serializing the enterprise version (education) by any chance? We can't seem to serialize using the serializing tool. the CC 2014 reverts to a trial...

    Jon....
    Don't confuse the threads here with 'typical' experience.  Most of the stuff here is from brand new users, and those that have problems, and considering the 30 million pads in use, represent a very small sliver.
    If you are having repeated crashes it is really pretty basic.  You either have a physical problem with your pad, or you are using too much memory.
    The iOS system is supposed to monitor memory, and shut down previously used apps automatically to free up memory for what you are doing now.  That part of ios is not perfect, and if an app introduces an unexpected memory load, sometimes it gets over whelmed.  
    This happens, more often than not, when using safari with multiple windows open on graphic intense sites.  It can also happen with a memory intensive game, and residual apps in the background.
    Double  tap the home key and take a peek at the recently used list, and shut them down completely, and often the problem goes away.
    If the problem persists, you may have a software issue, and a trip to the genius bar may be in order.

  • What's the difference between educational and student editions of Flash?

    I qualify for both the educational and student editions of Adobe CS4, and I'm not sure which one to buy.
    Does the educational version have any significant advantages over the student version?
    Can the educational version be used for commercial purposes (I know the student one can't)?
    Are there any extra features or templates that are only available in the educational version and above?
    Can I transfer the liscense for the student version to another computer?
    My trial version lasts only 5 more days and I hope to have purchased a registered edition by than
    Thanks in advance for any replies

    Thanks I did some further research
    and
    According to http://www.studentdiscounts.com.au
    The student edition:
    ...Limit of one per customer per 12 month period can be purchased.
    Students will be required to provide Adobe with proof of their current student status to install the product. Students must be enrolled in a degree-granting program at an acceptable Education Institution (being a bona fide university or college including community, junior and vocational colleges or other further education colleges that grants degrees requiring not less than the equivalent of two (2) years of full time study) OR Students must be enrolled at an accredited public or private secondary school providing full-time instruction.
    This software may only be used on a privately-owned computer. The product may not be used for commercial purposes.
    The educational edition:
    <Description same as full version with nothing mentioned about commercial purposes.>
    unresolved/further questions:
    There are some other people which say that the educational version can be used for commercial purposes. e.g.
    http://forums.macrumors.com/showthread.php?t=369107
    http://www.designerstalk.com/forums/software/25666-adobe-student-licensing.html (POST # 14)
    If one designed a logo/animation for a friend's small business would adobe consider that as a "commercial purpose".
    As for the "...limit of one per customer per 12 month period can be purchased" really mean?
    It kind of implies that the student edition is only activated for 12 months (an extended trail version)
    According to  http://forums.macrumors.com/showthread.php?t=369107 the educational version can be upgraded but the student one can't.
    Is this true?

  • I am trying to buy songs on itunes and half way through the terms and conditions come up, I accept them and press return and then I get a 'session timed out' notice and the sale hasn't gone through - tried loads of times / updating software, any answers?

    I am trying to buy songs on itunes and half way through the terms and conditions come up, I accept them and press return and then I get a 'session timed out' notice and the sale hasn't gone through - tried loads of times / updating software, any answers?

    I am trying to buy songs on itunes and half way through the terms and conditions come up, I accept them and press return and then I get a 'session timed out' notice and the sale hasn't gone through - tried loads of times / updating software, any answers?

  • How can I enter my podcast in more than one category?  Mine covers arts, education and society and culture, but is listed as "Performing Arts".  Thank you for your time!

    How can I enter my podcast in more than one category, to reflect the fact that it covers arts, education and society and culture?  Thank you for your time!

    You can have more than one category - this page shows you how the tags are formed:
    http://www.apple.com/itunes/podcasts/specs.html#category
    The Store will list only the first category and its sub-category at the top of the page. Like the first category, the others will in theory make your podcast available for searching by category. However searching just on the category in the iTunes Store is most unlikely to throw up your podcast. There are thousands of podcasts out there, and it would be quite impossible to display on one page the entire list for any category. What you see are 'featured' podcasts, chosen by Apple as being special; please see this Tech Note:
    http://www.apple.com/itunes/podcasts/specs.html#getfeatured
    Note that there is no way you can influence the selection other than making your podcast really special.
    If you have further questions about making your podcast it's better to ask them in the Producing Podcasts forum.

  • Unable to Enterprise Service Repository and Intergration Directory in SAP PI 7.1

    Hello Experts,
              I am unable to open Enterprise Service Repository and Integration Directory in SAP PI. The error displayed while opening the tools is "Can not find Message File". I have tried installing Java versions from 1.5 to 1.7 .Also all the Host and Services files entry are correctly pasted in drivers--> etc--> folder. But still the problem persists... Would request you help me on this so that i can start my work. Please find the below error screen shot... Thanks a lot in advance.
    Best Regards,
    Prashanth Bharadwaj.Ch

    Hi All,
         As per your previous conversation,If java is installed properly a pop up window will be opened. I have typed JAVAWS in run command. Please the below screen shot. Even the problem persists.. Kindly help. Thanks a lot in advance
    Best Regards,
    Prashanth Bharadwaj.Ch

  • My MacBook Pro will not open documents via Adobe Reader. Says I need to aspen Reader in Browzer and accept terms and contitions first. Went through this 3 times and got through to "Finish", closed browser and then retried. No luck. What's going on?? Have

    My MacBook Pro will not open documents via Adobe Reader. Says I need to aspen Reader in Browzer and accept terms and contitions first. Went through this 3 times and got through to "Finish", closed browser and then retried. No luck. What's going on?? Have no problem with same documents on iPhone and iPad

    After you finished installing did you launch Adobe Reader from your /Applications folder and accept EULA(End User License Agreement)?
    What is your Adobe Reader version?
    What browser are you using and browser version?
    Thank You.

  • HT4623 I downloaded ios 7, and now i need to accept something in the app-store, but i can't accept it, and now i can't download a thing from the appstore anymore, someone knows how to fix it?

    I downloaded ios 7, and now i need to accept something in the app-store, but i can't accept it, and now i can't download a thing from the appstore anymore, someone knows how to fix it?

    Why can't it be accepted?
    What is "it"?
    If help is desired, stop being vague.

  • I downloaded ios 7, and now i need to accept something in the app-store, but i can't accept it, and now i can't download a thing from the appstore anymore, someone knows how to fix it?

    I downloaded ios 7, and now i need to accept something in the app-store, but i can't accept it, and now i can't download a thing from the appstore anymore, someone knows how to fix it?

    Hello, Robke100.
    I would recommend trying the steps in the article below.
    iOS: Turning off and on (restarting) and resetting
    http://support.apple.com/kb/ht1430
    Once these steps are processed, attempt to accept the terms and conditions.
    Also, you can make a purchase via the iTunes Store on the computer.  This should allow you to bypass accepting the terms and conditions on the device.
    Cheers,
    Jason H.

  • I just entered my $100 iTunes card and it said it accepted it and sd my bal was $93.49???

    I just entered my $100 iTunes card and it said it accepted it and sd my bal was $93.49??? Is there some sort of fee that goes along with it?? I don't get it. I paid $100. I don't want to spend $94 of it... What am I missing?

    You need to ask Apple to reset your security questions; ways of contacting them include clicking here and picking a method for your country, phoning AppleCare and asking for the Account Security team, and filling out and submitting this form.
    (98714)

  • I have an iphone 5 and i just updated it to ios7 and it kept asking for codes and wouldnt accept any and now it just says iphone disconnected.please help

    I have an iphone 5 and i just updated it to ios7 and it kept asking for codes and wouldnt accept any and now it just says iphone disconnected.please help

    Are you attempting to synchronise new or existing photographs between your devices? My Photo Stream can only synchronise new photographs.

  • HT4913 one of my two phones accepted imatch and the other says that i meed to subscribe. Why?

    one of my two phones accepted imatch and the other says that i meed to subscribe. Why?

    Try resetting the one dropping calls more often.  Hold the on/off and home switches together for about 10 seconds till the Apple logo appears.
    If that doesn't help, consider restoring it using iTunes.

  • HT201304 I want to buy new level from candy crush, but unfortunately apple required to accept terms and condition first before I can buy. But once I click yes no more option to click I agree with the condition. what should I do?

    I want to buy new level from candy crush, but unfortunately apple required to accept terms and condition first before I can buy. But once I click yes no more option to click I agree with the condition. what should I do?

    Perform a Reset... Try again...
    Reset  ( No Data will be Lost )
    Press and hold the Sleep/Wake button and the Home button at the same time for at least ten seconds, until the Apple logo appears. Release the Buttons.
    http://support.apple.com/kb/ht1430

  • HT5570 since updating my iphone to iOS7 I cannot update apps because I am unable to accept terms and coditions.

    Since updating to iOS7 on my iphone 4s, I am unable to update my apps. I am unable to accept the terms and conditions needed. I have laboriously turned all  the pages only to find no box to check to accept the terms. It will not send as an email as it offers. Has anyone had this happen and found a solution?

    Press and hold the power and home button until the apple logo shows up, when it restarts go and try to accept them. If it still doesn't work you can go to seetings>general>reset> and reset all settings it should be the first option. Alternately if you have a computer with itunes you can go there and try downloading an app it should ask you to accept terms and conditions there.

Maybe you are looking for

  • Can't Get Blackberry Onto The Internet

    Hi Everyone! Sorry if this has been asked before. I've been given a Blackberry Pearl on the T Mobile network. My SIM card is on Virgin UK so it lets me make calls and receive text messages but whenever I try to get on the internet it says there's a p

  • I accidently unplugged my ipod during an update and it made me restore it. how do i get my $40  worth off apps and music?

    Hey i would really like my stuff back but i need help getting it back Thanks.

  • [Flex SDK in Linux] Errors running a .swf file

    Hi! Trying to set up flash development on my linux machine. Using FDT in Eclipse. The version of Flex sdk I have is 4.6.0.23201-2. I have in the first place had problems running the project. It gets terminated instantly and I get this output in my te

  • ODS Designing.

    Hi Bw Experts,    Currently i am developing the report for <b>Advance Payments for Suppliers</b> according to the Project.I have identified the datasource as 0FI_AP_4.For project details i have identified the datasource as 0PROJECT_ATTR.I have a doub

  • How to leave Palm with Bonsai?

    I am a non-techie so I am seeking advice that even someone such as I can understand. I love Natara's Bonsai organizer and I have a ton of things in it.  I am using a Palm T|X and Bonsai desktop 5 on Vista. I would be quite happy to keep this system f