Re: creating user guides in an agile environment
I've worked with varying degrees of agility including strict, by-the-book Scrum. Documentation *must* be loosely coupled and sometimes must follow one or more sprints after the development. My major example for why this is was an update to OpenLDAP that took the developer a few days to implement. Documenting migration to the new version took me over two months because it was so complex and had so many variables. The big plus of strict Scrum for me was that I never had any surprises. All work that developers were doing was defined at the beginning of each sprint, and I could see from JIRA or Bugzilla what was ready for me to start work (typically when the developer assigned the task to QA). That was the only time I've ever known for sure that my documentation was 100% complete. On Fri, May 15, 2015 at 9:16 AM, Johnson, Joyce jjohn...@abtg.com wrote: Is anyone writing software user guides for end users in an environment in which the software is being developed following agile guidelines? If so, are you writing portions of the user guide at each software iteration? How do you handle major revisions to the software? That is, if you wrote a section of the user guide on the deliverables produced in the first iteration, then learned that the software you wrote about changed in the 4th iteration, what did you do? How did that affect your timeline? Do you find writing in iterations more beneficial than waiting until the software is in a more finished state? ___ You are currently subscribed to framers as arch...@mail-archive.com. Send list messages to framers@lists.frameusers.com. To unsubscribe send a blank email to framers-unsubscr...@lists.frameusers.com or visit http://lists.frameusers.com/mailman/options/framers/archive%40mail-archive.com Send administrative questions to listad...@frameusers.com. Visit http://www.frameusers.com/ for more resources and info.
RE: creating user guides in an agile environment
You may want to check out Colum McAndrew's blog post - http://www.uacolumn.com/our-agile-journey/ to exchange some ideas on who they are dealing with Agile development. From: framers-boun...@lists.frameusers.com [mailto:framers-boun...@lists.frameusers.com] On Behalf Of Johnson, Joyce Sent: May-15-15 12:17 PM To: framers@lists.frameusers.com Subject: creating user guides in an agile environment All - Is anyone writing software user guides for end users in an environment in which the software is being developed following agile guidelines? If so, are you writing portions of the user guide at each software iteration? How do you handle major revisions to the software? That is, if you wrote a section of the user guide on the deliverables produced in the first iteration, then learned that the software you wrote about changed in the 4th iteration, what did you do? How did that affect your timeline? Do you find writing in iterations more beneficial than waiting until the software is in a more finished state? Thanks in advance for any feedback. Joyce jjohn...@abtg.commailto:jjohn...@abtg.com CONFIDENTIALITY NOTICE: This electronic mail transmission may contain privileged and/or confidential information and is intended only for the review of the party to whom it is addressed. If you have received this transmission in error, please immediately return it to the sender, delete it and destroy it without reading it. Unintended transmission shall not constitute the waiver of the attorney-client or any other privilege. ___ You are currently subscribed to framers as arch...@mail-archive.com. Send list messages to framers@lists.frameusers.com. To unsubscribe send a blank email to framers-unsubscr...@lists.frameusers.com or visit http://lists.frameusers.com/mailman/options/framers/archive%40mail-archive.com Send administrative questions to listad...@frameusers.com. Visit http://www.frameusers.com/ for more resources and info.
Re: creating user guides in an agile environment
I wrote in Agile several years ago while at EMC. I liked it, most of the other writers hated it. Yes, sometimes I had to rewrite in a later iteration, but that's pretty much normal in any development environment. What I liked was being able to include document review at the end of each iteration so they could not close the iteration unless they did their review. John X Posada AML Syst Ops Supt Data Analyst | US FCC RC Systems Control Analytics | HSBC North America Holdings Inc 330 Madison Ave., NY NY ___ Phone Int: 212-525-5483 Ext: Personal Cellphone - 732-259-2874 Fax Conference Bridge - 877-304-0052, Code 74809254 Email john.x.pos...@us.hsbc.com ___ Protect our environment - please only print this if you have to! From: Johnson, Joyce jjohn...@abtg.com To: framers@lists.frameusers.com framers@lists.frameusers.com Date: 05/15/2015 01:40 PM Subject:creating user guides in an agile environment Sent by:framers-boun...@lists.frameusers.com All – Is anyone writing software user guides for end users in an environment in which the software is being developed following agile guidelines? If so, are you writing portions of the user guide at each software iteration? How do you handle major revisions to the software? That is, if you wrote a section of the user guide on the deliverables produced in the first iteration, then learned that the software you wrote about changed in the 4 th iteration, what did you do? How did that affect your timeline? Do you find writing in iterations more beneficial than waiting until the software is in a more finished state? Thanks in advance for any feedback. Joyce jjohn...@abtg.com CONFIDENTIALITY NOTICE: This electronic mail transmission may contain privileged and/or confidential information and is intended only for the review of the party to whom it is addressed. If you have received this transmission in error, please immediately return it to the sender, delete it and destroy it without reading it. Unintended transmission shall not constitute the waiver of the attorney-client or any other privilege. ** This message originated from the Internet. Its originator may or may not be who they claim to be and the information contained in the message and any attachments may or may not be accurate. ** ___ You are currently subscribed to framers as john.x.pos...@us.hsbc.com. Send list messages to framers@lists.frameusers.com. To unsubscribe send a blank email to framers-unsubscr...@lists.frameusers.com or visit http://lists.frameusers.com/mailman/options/framers/john.x.posada%40us.hsbc.com Send administrative questions to listad...@frameusers.com. Visit http://www.frameusers.com/ for more resources and info. ** This message originated from the Internet. Its originator may or may not be who they claim to be and the information contained in the message and any attachments may or may not be accurate. ** - ** This E-mail is confidential. It may also be legally privileged. If you are not the addressee you may not copy, forward, disclose or use any part of it. If you have received this message in error, please delete it and all copies from your system and notify the sender immediately by return E-mail. Internet communications cannot be guaranteed to be timely, secure, error or virus-free. The sender does not accept liability for any errors or omissions. ** SAVE PAPER - THINK BEFORE YOU PRINT! ___ You are currently subscribed to framers as arch...@mail-archive.com. Send list messages
creating user guides in an agile environment
All - Is anyone writing software user guides for end users in an environment in which the software is being developed following agile guidelines? If so, are you writing portions of the user guide at each software iteration? How do you handle major revisions to the software? That is, if you wrote a section of the user guide on the deliverables produced in the first iteration, then learned that the software you wrote about changed in the 4th iteration, what did you do? How did that affect your timeline? Do you find writing in iterations more beneficial than waiting until the software is in a more finished state? Thanks in advance for any feedback. Joyce jjohn...@abtg.com CONFIDENTIALITY NOTICE: This electronic mail transmission may contain privileged and/or confidential information and is intended only for the review of the party to whom it is addressed. If you have received this transmission in error, please immediately return it to the sender, delete it and destroy it without reading it. Unintended transmission shall not constitute the waiver of the attorney-client or any other privilege. ___ You are currently subscribed to framers as arch...@mail-archive.com. Send list messages to framers@lists.frameusers.com. To unsubscribe send a blank email to framers-unsubscr...@lists.frameusers.com or visit http://lists.frameusers.com/mailman/options/framers/archive%40mail-archive.com Send administrative questions to listad...@frameusers.com. Visit http://www.frameusers.com/ for more resources and info.
Re: creating user guides in an agile environment
Well, one thing some of the contributors got wrong is that while Scrum is a proper noun, agile is not. Some of the articles are password-protected, the ones that aren't don't suggest that it would be worth paying the ripoff membership fees to get access. On Fri, May 15, 2015 at 10:31 AM, Stuart Rogers srog...@phoenix-geophysics.com wrote: The nov/dec 2014 issue of Intercom was all about Agile; maybe it will help. http://intercom.stc.org/magazine/novemberdecember-2014/ ___ You are currently subscribed to framers as arch...@mail-archive.com. Send list messages to framers@lists.frameusers.com. To unsubscribe send a blank email to framers-unsubscr...@lists.frameusers.com or visit http://lists.frameusers.com/mailman/options/framers/archive%40mail-archive.com Send administrative questions to listad...@frameusers.com. Visit http://www.frameusers.com/ for more resources and info.
Re: creating user guides in an agile environment
Yes, that's a big plus. Also being able to assign provide information necessary to document this tasks when the doc took too much work to complete in the same sprint. On Fri, May 15, 2015 at 11:12 AM, john.x.pos...@us.hsbc.com wrote: ... What I liked was being able to include document review at the end of each iteration so they could not close the iteration unless they did their review. ... ___ You are currently subscribed to framers as arch...@mail-archive.com. Send list messages to framers@lists.frameusers.com. To unsubscribe send a blank email to framers-unsubscr...@lists.frameusers.com or visit http://lists.frameusers.com/mailman/options/framers/archive%40mail-archive.com Send administrative questions to listad...@frameusers.com. Visit http://www.frameusers.com/ for more resources and info.
RE: creating user guides in an agile environment
We don't use a pure Agile process, but I do find that Sales prefers a shorter time once the software is ready for release. I develop the documentation as software development progresses. I have to redo sections, but I can also get the documentation to them much more quickly at the end. YMMV. Lea Lea Rush Software and Documentation Specialist Astoria-Pacific www.astoria-pacific.comhttp://www.astoria-pacific.com/ P: 800-536-3111, +1-503-657-3010 Please consider the environment before printing this email. `·.¸¸.·´¯`·.¸.·´¯`·...¸ º`·.¸¸.·´¯`·.¸.·´¯`·...¸º NOTICE OF CONFIDENTIALITY This communication is from Astoria-Pacific and is intended to be confidential and solely for the use of the persons or entities addressed above. If you are not an intended recipient, be aware that the information contained herein may be protected from unauthorized use by privilege or law, and any copying, distribution, disclosure, or other use of this information is prohibited. If you have received this communication in error, please contact the sender by return email or telephone (503) 657-3010 immediately, and delete or destroy all copies. Thank you for your cooperation. From: framers-boun...@lists.frameusers.com [mailto:framers-boun...@lists.frameusers.com] On Behalf Of Johnson, Joyce Sent: May 15, 2015 9:17 AM To: framers@lists.frameusers.com Subject: creating user guides in an agile environment All - Is anyone writing software user guides for end users in an environment in which the software is being developed following agile guidelines? If so, are you writing portions of the user guide at each software iteration? How do you handle major revisions to the software? That is, if you wrote a section of the user guide on the deliverables produced in the first iteration, then learned that the software you wrote about changed in the 4th iteration, what did you do? How did that affect your timeline? Do you find writing in iterations more beneficial than waiting until the software is in a more finished state? Thanks in advance for any feedback. Joyce jjohn...@abtg.commailto:jjohn...@abtg.com CONFIDENTIALITY NOTICE: This electronic mail transmission may contain privileged and/or confidential information and is intended only for the review of the party to whom it is addressed. If you have received this transmission in error, please immediately return it to the sender, delete it and destroy it without reading it. Unintended transmission shall not constitute the waiver of the attorney-client or any other privilege. ___ You are currently subscribed to framers as arch...@mail-archive.com. Send list messages to framers@lists.frameusers.com. To unsubscribe send a blank email to framers-unsubscr...@lists.frameusers.com or visit http://lists.frameusers.com/mailman/options/framers/archive%40mail-archive.com Send administrative questions to listad...@frameusers.com. Visit http://www.frameusers.com/ for more resources and info.
Re: creating user guides in an agile environment
On 2015-May-15 12:16 PM, Johnson, Joyce wrote: All – Is anyone writing software user guides for end users in an environment in which the software is being developed following agile guidelines? If so, are you writing portions of the user guide at each software iteration? How do you handle major revisions to the software? That is, if you wrote a section of the user guide on the deliverables produced in the first iteration, then learned that the software you wrote about changed in the 4^th iteration, what did you do? How did that affect your timeline? Do you find writing in iterations more beneficial than waiting until the software is in a more finished state? Thanks in advance for any feedback. The nov/dec 2014 issue of Intercom was all about Agile; maybe it will help. http://intercom.stc.org/magazine/novemberdecember-2014/ -- Stuart Rogers Technical Communicator Phoenix Geophysics Limited 3781 Victoria Park Avenue, Unit 3 Toronto, ON, Canada M1W 3K5 +1 (416) 491-7340 x 325 http://www.phoenix-geophysics.com ___ You are currently subscribed to framers as arch...@mail-archive.com. Send list messages to framers@lists.frameusers.com. To unsubscribe send a blank email to framers-unsubscr...@lists.frameusers.com or visit http://lists.frameusers.com/mailman/options/framers/archive%40mail-archive.com Send administrative questions to listad...@frameusers.com. Visit http://www.frameusers.com/ for more resources and info.
