<div dir="ltr">I didn't get any input, so I'm going to send these as-is to request inclusion in the user survey.<div><br></div><div>Thanks,</div><div>Anne</div></div><div class="gmail_extra"><br><br><div class="gmail_quote">

On Thu, Jan 23, 2014 at 7:44 PM, Anne Gentle <span dir="ltr"><<a href="mailto:anne@openstack.org" target="_blank">anne@openstack.org</a>></span> wrote:<br><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex">

<div dir="ltr">Hi again all, <div>Tim Bell has set a deadline of March 1st for getting user questions in the next survey. </div><div><br></div><div>I'd like input on these questions by Feb. 14, please write your suggestions to the list and I'll gather and send to the user committee. </div>


<div><br></div><div>Thanks,</div><div>Anne </div></div><div class="HOEnZb"><div class="h5"><div class="gmail_extra"><br><br><div class="gmail_quote">On Thu, Jan 16, 2014 at 7:48 PM, Anne Gentle <span dir="ltr"><<a href="mailto:anne@openstack.org" target="_blank">anne@openstack.org</a>></span> wrote:<br>


<blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex"><div dir="ltr">Hi all, <div>Everett Towes has started a nice thread about adding specific questions to the user survey, so I wanted to get input on adding these specific questions about docs to the user survey. </div>


<div>
<br></div><div>I used these questions about API docs in an internal-to-Rackspace survey and I think they'll transfer well to the end-user audience.</div><br><br>1. What is your number one top priority in evaluating API and SDK docs as a consumer of them? Rank first and second only. <br>



Accuracy<br>Proof that it's reviewed or tested<br>Quality <br>Professional polish and editing<br>Meeting end-user needs<br>Consistency<br>Timely updates<br>Clear feedback channel<br>Uses a formatting standard correct for the language<div>



I don't consume them<br><div><div><div><div language="JavaScript">

</div>

</div>

</div>

</div><div><br></div>2. What are the most valuable features of the current OpenStack API docs?<br><br>Ability to comment<br>Storing source in Github (so that I can collaborate on docs)<br>Review workflow that enables edits to be approved<br>



Syntax highlighting for code samples<br>Look and feel<br>Support for translations<br>Multiple outputs (PDF, HTML, ebook)<br><br>3. What do the current OpenStack API docs lack?<br><br>Well-organized content across projects<br>



Intuitive editing workflow<br>Stability, reliable output processing<br>Search functionality<br>Ease of incorporating working tested samples<br>Low or no cost licensing of tool chain<br>Community collaboration<br>Automation<div>



<br></div><div>Once we have a set of questions we like, I'll send to the user-committe mailing list. </div><div><br></div><div>If you think we should focus on deployer docs as "users" also let us know. I would guess we would get 2-3 questions max so we'll have to prioritize.</div>



<div><br></div><div>Thanks,</div><div>Anne</div></div></div>
</blockquote></div><br></div>
</div></div></blockquote></div><br></div>