<div dir="ltr">Hi user committee -- <div>Any additional information needed here? Let me know if you can get this in.</div><div>Anne</div></div><div class="gmail_extra"><br><br><div class="gmail_quote">On Sun, Feb 23, 2014 at 4:58 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>I'd like to see some specific questions around the API documentation for the User Survey. </div>

<div><br></div><div>I wouldn't mind also adding questions about the install/config/operator docs to the survey, but I would prefer to start here since this is the first time app devs will be targeted. If we could add one additional question for the docs overall, it would be the first question. </div>


<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<br>I don't consume them<br><br>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>Thanks!</div><span class="HOEnZb"><font color="#888888"><div>Anne</div></font></span></div>


</blockquote></div><br></div>