<?xml version="1.0" encoding="UTF-8"?><rss version="2.0"
	xmlns:content="http://purl.org/rss/1.0/modules/content/"
	xmlns:dc="http://purl.org/dc/elements/1.1/"
	xmlns:atom="http://www.w3.org/2005/Atom"
	xmlns:sy="http://purl.org/rss/1.0/modules/syndication/"
		>
<channel>
	<title>Comments on: Writing End-User Documentation in an Agile Development Environment</title>
	<atom:link href="http://justwriteclick.com/2007/07/02/writing-end-user-documentation-in-an-agile-development-environment/feed/" rel="self" type="application/rss+xml" />
	<link>http://justwriteclick.com/2007/07/02/writing-end-user-documentation-in-an-agile-development-environment/</link>
	<description>Documentation as conversation</description>
	<lastBuildDate>Sun, 14 Mar 2010 16:58:51 +0000</lastBuildDate>
	<generator>http://wordpress.org/?v=2.9</generator>
	<sy:updatePeriod>hourly</sy:updatePeriod>
	<sy:updateFrequency>1</sy:updateFrequency>
		<item>
		<title>By: annegentle</title>
		<link>http://justwriteclick.com/2007/07/02/writing-end-user-documentation-in-an-agile-development-environment/comment-page-1/#comment-35749</link>
		<dc:creator>annegentle</dc:creator>
		<pubDate>Tue, 20 Oct 2009 17:12:45 +0000</pubDate>
		<guid isPermaLink="false">http://annegentle.wordpress.com/2007/07/02/writing-end-user-documentation-in-an-agile-development-environment/#comment-35749</guid>
		<description>Hi Karina - thanks for posting, and I&#039;m glad the article is helpful! 

I am once again on an Agile development team, and we are running into something similar I believe. There are heavy development tasks that I can&#039;t do, but I would like to learn more about how to do them. So I am taking small steps towards learning more about the &quot;guts&quot; of the product I document. For example, since we work on a web application, it&#039;s good for me to work on CSS bugs that come onto our board, if a developer is not available. I think the main thing to do is to be available and ready for any task - I don&#039;t think you need to send your writers to special training for specialized development tasks. I think it&#039;s okay for each team member to have a specialty. My specialty happens to intersect with web applications since I know web content management (and styling) well. I also test quite a lot (let me emphasize A LOT), following legacy test plans when it makes sense (we&#039;re not creating new test plans in our Agile environment).

So, as usual, it depends on the product you&#039;re working on. Are there any small-ish development tasks that are entry-level? Maybe start with those. But also realize you can keep training writers in their specialty and not ask them to become newly-trained specialists in programming or testing.</description>
		<content:encoded><![CDATA[<p>Hi Karina &#8211; thanks for posting, and I&#8217;m glad the article is helpful! </p>
<p>I am once again on an Agile development team, and we are running into something similar I believe. There are heavy development tasks that I can&#8217;t do, but I would like to learn more about how to do them. So I am taking small steps towards learning more about the &#8220;guts&#8221; of the product I document. For example, since we work on a web application, it&#8217;s good for me to work on CSS bugs that come onto our board, if a developer is not available. I think the main thing to do is to be available and ready for any task &#8211; I don&#8217;t think you need to send your writers to special training for specialized development tasks. I think it&#8217;s okay for each team member to have a specialty. My specialty happens to intersect with web applications since I know web content management (and styling) well. I also test quite a lot (let me emphasize A LOT), following legacy test plans when it makes sense (we&#8217;re not creating new test plans in our Agile environment).</p>
<p>So, as usual, it depends on the product you&#8217;re working on. Are there any small-ish development tasks that are entry-level? Maybe start with those. But also realize you can keep training writers in their specialty and not ask them to become newly-trained specialists in programming or testing.</p>
]]></content:encoded>
	</item>
	<item>
		<title>By: Becky Williams</title>
		<link>http://justwriteclick.com/2007/07/02/writing-end-user-documentation-in-an-agile-development-environment/comment-page-1/#comment-35735</link>
		<dc:creator>Becky Williams</dc:creator>
		<pubDate>Thu, 15 Oct 2009 17:40:58 +0000</pubDate>
		<guid isPermaLink="false">http://annegentle.wordpress.com/2007/07/02/writing-end-user-documentation-in-an-agile-development-environment/#comment-35735</guid>
		<description>Karina, our team is probably somewhere in the middle on this issue.  We have team collaboration in terms of sharing ideas, for sure, but not true job sharing.

Also, as a technical writer, I frequently log bugs I find, although I am not following a test plan or covering an entire area of the app.  I have also pointed out misses in terms of requirements that can sometimes get us off track.  And, I sometimes get notes from developers who have input on how Help is worded or what content is included.

This being said, I don&#039;t have it in my plan to learn development other than how it relates to documentation and/or training.  
There are some borderline cases where I may need to learn a bit of development in order to get something I need implemented for doc/training because the dev team doesn&#039;t have experience in that area.

Is this what others are experiencing?</description>
		<content:encoded><![CDATA[<p>Karina, our team is probably somewhere in the middle on this issue.  We have team collaboration in terms of sharing ideas, for sure, but not true job sharing.</p>
<p>Also, as a technical writer, I frequently log bugs I find, although I am not following a test plan or covering an entire area of the app.  I have also pointed out misses in terms of requirements that can sometimes get us off track.  And, I sometimes get notes from developers who have input on how Help is worded or what content is included.</p>
<p>This being said, I don&#8217;t have it in my plan to learn development other than how it relates to documentation and/or training.<br />
There are some borderline cases where I may need to learn a bit of development in order to get something I need implemented for doc/training because the dev team doesn&#8217;t have experience in that area.</p>
<p>Is this what others are experiencing?</p>
]]></content:encoded>
	</item>
	<item>
		<title>By: Karina</title>
		<link>http://justwriteclick.com/2007/07/02/writing-end-user-documentation-in-an-agile-development-environment/comment-page-1/#comment-35734</link>
		<dc:creator>Karina</dc:creator>
		<pubDate>Thu, 15 Oct 2009 08:50:48 +0000</pubDate>
		<guid isPermaLink="false">http://annegentle.wordpress.com/2007/07/02/writing-end-user-documentation-in-an-agile-development-environment/#comment-35734</guid>
		<description>Thanks for this article, which I just now found! I am documentation manager at a smallish company and have a team of 8 tech writers who all work in their own scrum teams. My company adopted agile last year and so far it works very well. The problem is, that some people in my company are extremely scrum enthusiastic and want to follow it to the point (which is also good). So they are saying that in a scrum team everyone should do everything, meaning, that teach writers should be able to do development and testing tasks, developers tech writing tasks etc. Even though I have been trying to ask them if they the would be willing to train the tech writer to learn Java or send the developers to an English class (my company is in Finland, documents are written in English), it&#039;s not helping. I have been trying to find resources on the net that would say (apparently if it&#039;s written on Internet, it&#039;s true) something about this and possibly back my point, but I haven&#039;t found anything. Seems that everyone else takes it as granted that writers (who have no experience or interest in software development) don&#039;t write complex code. Has anyone come across this problem?</description>
		<content:encoded><![CDATA[<p>Thanks for this article, which I just now found! I am documentation manager at a smallish company and have a team of 8 tech writers who all work in their own scrum teams. My company adopted agile last year and so far it works very well. The problem is, that some people in my company are extremely scrum enthusiastic and want to follow it to the point (which is also good). So they are saying that in a scrum team everyone should do everything, meaning, that teach writers should be able to do development and testing tasks, developers tech writing tasks etc. Even though I have been trying to ask them if they the would be willing to train the tech writer to learn Java or send the developers to an English class (my company is in Finland, documents are written in English), it&#8217;s not helping. I have been trying to find resources on the net that would say (apparently if it&#8217;s written on Internet, it&#8217;s true) something about this and possibly back my point, but I haven&#8217;t found anything. Seems that everyone else takes it as granted that writers (who have no experience or interest in software development) don&#8217;t write complex code. Has anyone come across this problem?</p>
]]></content:encoded>
	</item>
	<item>
		<title>By: Becky Williams</title>
		<link>http://justwriteclick.com/2007/07/02/writing-end-user-documentation-in-an-agile-development-environment/comment-page-1/#comment-35686</link>
		<dc:creator>Becky Williams</dc:creator>
		<pubDate>Wed, 23 Sep 2009 16:28:03 +0000</pubDate>
		<guid isPermaLink="false">http://annegentle.wordpress.com/2007/07/02/writing-end-user-documentation-in-an-agile-development-environment/#comment-35686</guid>
		<description>Over the last year+, I have found it easy to write in an Agile way when it comes to the development tasks that occur during the sprint; however, I often have difficulty with tasks that continue for more than one sprint or do not rely on interaction with developers at all.

Recently, I found an easier way to handle one such item...Release Notes.  I estimate the entire task of creating Release Notes, then I divide that estimate by the number of expected sprints before functionality is delivered to clients.  If the estimate is not easily divisible by that number, I add any extra time to the final sprint.  During each sprint, I have a Release Notes task.  In the first sprint, I create the document and add bug fixes/enhancements that are developed during that sprint.  Reviews of this work should also be completed durint sprint one.  When the sprint is finished, this part of the doc should also be finished.  During each sprint, I add the part of the work that pertains to that sprint, and during the final sprint, I get final reviews and publish the doc in PDF.  We use MS Word&#039;s Track Changes feature to help reviewers know what is &quot;new&quot; for that sprint.

Hope this helps!</description>
		<content:encoded><![CDATA[<p>Over the last year+, I have found it easy to write in an Agile way when it comes to the development tasks that occur during the sprint; however, I often have difficulty with tasks that continue for more than one sprint or do not rely on interaction with developers at all.</p>
<p>Recently, I found an easier way to handle one such item&#8230;Release Notes.  I estimate the entire task of creating Release Notes, then I divide that estimate by the number of expected sprints before functionality is delivered to clients.  If the estimate is not easily divisible by that number, I add any extra time to the final sprint.  During each sprint, I have a Release Notes task.  In the first sprint, I create the document and add bug fixes/enhancements that are developed during that sprint.  Reviews of this work should also be completed durint sprint one.  When the sprint is finished, this part of the doc should also be finished.  During each sprint, I add the part of the work that pertains to that sprint, and during the final sprint, I get final reviews and publish the doc in PDF.  We use MS Word&#8217;s Track Changes feature to help reviewers know what is &#8220;new&#8221; for that sprint.</p>
<p>Hope this helps!</p>
]]></content:encoded>
	</item>
	<item>
		<title>By: annegentle</title>
		<link>http://justwriteclick.com/2007/07/02/writing-end-user-documentation-in-an-agile-development-environment/comment-page-1/#comment-35647</link>
		<dc:creator>annegentle</dc:creator>
		<pubDate>Mon, 14 Sep 2009 20:28:39 +0000</pubDate>
		<guid isPermaLink="false">http://annegentle.wordpress.com/2007/07/02/writing-end-user-documentation-in-an-agile-development-environment/#comment-35647</guid>
		<description>Wow, great that this article is still so helpful 2 years after we wrote it! I revisit the concepts myself now that I&#039;m back as a writer embedded Agile team. Just last week I mentioned to someone trying to figure out how book-based PDF files could be more Agile, and found myself saying, do a content audit to find out what could be the topics in your new doc deliverable. Then I found myself attempting a content audit as well. It takes a lot of fine-tuning along the way, also.</description>
		<content:encoded><![CDATA[<p>Wow, great that this article is still so helpful 2 years after we wrote it! I revisit the concepts myself now that I&#8217;m back as a writer embedded Agile team. Just last week I mentioned to someone trying to figure out how book-based PDF files could be more Agile, and found myself saying, do a content audit to find out what could be the topics in your new doc deliverable. Then I found myself attempting a content audit as well. It takes a lot of fine-tuning along the way, also.</p>
]]></content:encoded>
	</item>
	<item>
		<title>By: jojomonkey</title>
		<link>http://justwriteclick.com/2007/07/02/writing-end-user-documentation-in-an-agile-development-environment/comment-page-1/#comment-35646</link>
		<dc:creator>jojomonkey</dc:creator>
		<pubDate>Mon, 14 Sep 2009 20:24:57 +0000</pubDate>
		<guid isPermaLink="false">http://annegentle.wordpress.com/2007/07/02/writing-end-user-documentation-in-an-agile-development-environment/#comment-35646</guid>
		<description>thanks, i&#039;m reviewing customer documentation as we speak in an agile dev. env. and was asking myself that there has to be a way to get our doc. team to jive better w/ our dev. model. i think this article is going to really help, esp. if people integrate it.</description>
		<content:encoded><![CDATA[<p>thanks, i&#8217;m reviewing customer documentation as we speak in an agile dev. env. and was asking myself that there has to be a way to get our doc. team to jive better w/ our dev. model. i think this article is going to really help, esp. if people integrate it.</p>
]]></content:encoded>
	</item>
	<item>
		<title>By: Jenny</title>
		<link>http://justwriteclick.com/2007/07/02/writing-end-user-documentation-in-an-agile-development-environment/comment-page-1/#comment-35641</link>
		<dc:creator>Jenny</dc:creator>
		<pubDate>Sun, 13 Sep 2009 17:39:01 +0000</pubDate>
		<guid isPermaLink="false">http://annegentle.wordpress.com/2007/07/02/writing-end-user-documentation-in-an-agile-development-environment/#comment-35641</guid>
		<description>Gosh, Anne, thanks so much for this exploration! I come from a &quot;waterfall&quot; environment and am interviewing with a company that employs Agile. Without having used that name per se, they stated they organize features into stories and two-week windows. (Again, not having known that was Agile)I immediately determined to construct some sort of plan for attacking the documentation, trying to reconcile the two models. While surfing for clues I came to the conclusion that they are employing Agile, and then came upon your page. Great discussion, just in time. I will also check out Content Wrangler. Thanks again!</description>
		<content:encoded><![CDATA[<p>Gosh, Anne, thanks so much for this exploration! I come from a &#8220;waterfall&#8221; environment and am interviewing with a company that employs Agile. Without having used that name per se, they stated they organize features into stories and two-week windows. (Again, not having known that was Agile)I immediately determined to construct some sort of plan for attacking the documentation, trying to reconcile the two models. While surfing for clues I came to the conclusion that they are employing Agile, and then came upon your page. Great discussion, just in time. I will also check out Content Wrangler. Thanks again!</p>
]]></content:encoded>
	</item>
	<item>
		<title>By: LiveTechDocs - Documentation collaboration service</title>
		<link>http://justwriteclick.com/2007/07/02/writing-end-user-documentation-in-an-agile-development-environment/comment-page-1/#comment-32169</link>
		<dc:creator>LiveTechDocs - Documentation collaboration service</dc:creator>
		<pubDate>Tue, 14 Jul 2009 18:36:10 +0000</pubDate>
		<guid isPermaLink="false">http://annegentle.wordpress.com/2007/07/02/writing-end-user-documentation-in-an-agile-development-environment/#comment-32169</guid>
		<description>[...] which is a world and experience into itself. I wrote about that experience in an article in 2007 (Writing End-User Documentation in an Agile Development Environment) and I should revise it again, incorporating my most recent [...]</description>
		<content:encoded><![CDATA[<p>[...] which is a world and experience into itself. I wrote about that experience in an article in 2007 (Writing End-User Documentation in an Agile Development Environment) and I should revise it again, incorporating my most recent [...]</p>
]]></content:encoded>
	</item>
	<item>
		<title>By: Francis</title>
		<link>http://justwriteclick.com/2007/07/02/writing-end-user-documentation-in-an-agile-development-environment/comment-page-1/#comment-31924</link>
		<dc:creator>Francis</dc:creator>
		<pubDate>Fri, 10 Jul 2009 13:08:09 +0000</pubDate>
		<guid isPermaLink="false">http://annegentle.wordpress.com/2007/07/02/writing-end-user-documentation-in-an-agile-development-environment/#comment-31924</guid>
		<description>Thanks Anne,

Yes, that discussion is useful: at least I can confidently say that there&#039;s no standard up to now (my management is very much into doing things &quot;the standard way&quot;). 
Doing automatic generations is a bit complicated for me as AuthorIT and Acrobat both have tendencies to freeze in the middle of a generation, requiring manual re-starts.
I think the real questions are 
* when will anyone actually need the documentation?
* when will anyone actually read the documentation?
* when is the latest date when I will have time to produce the documentation before outputting to real clients?
In my organization, the iterations stay within a small circle of people inside the company, who aren&#039;t great documentation readers. 

Cheers,
Francis</description>
		<content:encoded><![CDATA[<p>Thanks Anne,</p>
<p>Yes, that discussion is useful: at least I can confidently say that there&#8217;s no standard up to now (my management is very much into doing things &#8220;the standard way&#8221;).<br />
Doing automatic generations is a bit complicated for me as AuthorIT and Acrobat both have tendencies to freeze in the middle of a generation, requiring manual re-starts.<br />
I think the real questions are<br />
* when will anyone actually need the documentation?<br />
* when will anyone actually read the documentation?<br />
* when is the latest date when I will have time to produce the documentation before outputting to real clients?<br />
In my organization, the iterations stay within a small circle of people inside the company, who aren&#8217;t great documentation readers. </p>
<p>Cheers,<br />
Francis</p>
]]></content:encoded>
	</item>
	<item>
		<title>By: annegentle</title>
		<link>http://justwriteclick.com/2007/07/02/writing-end-user-documentation-in-an-agile-development-environment/comment-page-1/#comment-31885</link>
		<dc:creator>annegentle</dc:creator>
		<pubDate>Thu, 09 Jul 2009 23:35:23 +0000</pubDate>
		<guid isPermaLink="false">http://annegentle.wordpress.com/2007/07/02/writing-end-user-documentation-in-an-agile-development-environment/#comment-31885</guid>
		<description>Great question Francis, and you&#039;d like the discussion going on in this thread at The Content Wrangler Communities&#039; Agile Documentation group: http://thecontentwrangler.ning.com/group/agiledevelopmentandtechnicalcommunications/forum/topics/question-of-the-week-how-1. 

As you might imagine, the answer is, it depends. It depends on the maturity of the product, and how detailed the designs are up front, and whether you&#039;re on a team that tends to throw out first prototypes that are coded. It also depends on how modular and topic-oriented your documentation is already. 

Your deliverable description is also interesting - not many Agile shops that I know of would be manually generating doc, instead it would be automated (even the file copying), and maybe part of the product build. So you may also look into automation so the process is less manual and time-consuming. 

Hope that helps! I&#039;d encourage you to post your question to the Content Wrangler Community as well to get more perspectives.</description>
		<content:encoded><![CDATA[<p>Great question Francis, and you&#8217;d like the discussion going on in this thread at The Content Wrangler Communities&#8217; Agile Documentation group: <a href="http://thecontentwrangler.ning.com/group/agiledevelopmentandtechnicalcommunications/forum/topics/question-of-the-week-how-1" rel="nofollow">http://thecontentwrangler.ning.com/group/agiledevelopmentandtechnicalcommunications/forum/topics/question-of-the-week-how-1</a>. </p>
<p>As you might imagine, the answer is, it depends. It depends on the maturity of the product, and how detailed the designs are up front, and whether you&#8217;re on a team that tends to throw out first prototypes that are coded. It also depends on how modular and topic-oriented your documentation is already. </p>
<p>Your deliverable description is also interesting &#8211; not many Agile shops that I know of would be manually generating doc, instead it would be automated (even the file copying), and maybe part of the product build. So you may also look into automation so the process is less manual and time-consuming. </p>
<p>Hope that helps! I&#8217;d encourage you to post your question to the Content Wrangler Community as well to get more perspectives.</p>
]]></content:encoded>
	</item>
</channel>
</rss>
