Open Stack

Hi user committee --
Any additional information needed here? Let me know if you can get this in.
Anne


On Sun, Feb 23, 2014 at 4:58 PM, Anne Gentle <anne at openstack.org> wrote:

> Hi all,
> I'd like to see some specific questions around the API documentation for
> the User Survey.
>
> 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.
>
> 1. What is your number one top priority in evaluating API and SDK docs as
> a consumer of them? Rank first and second only.
> Accuracy
> Proof that it's reviewed or tested
> Quality
> Professional polish and editing
> Meeting end-user needs
> Consistency
> Timely updates
> Clear feedback channel
> Uses a formatting standard correct for the language
> I don't consume them
>
> 2. What are the most valuable features of the current OpenStack API docs?
>
> Ability to comment
> Storing source in Github (so that I can collaborate on docs)
> Review workflow that enables edits to be approved
> Syntax highlighting for code samples
> Look and feel
> Support for translations
> Multiple outputs (PDF, HTML, ebook)
>
> 3. What do the current OpenStack API docs lack?
>
> Well-organized content across projects
> Intuitive editing workflow
> Stability, reliable output processing
> Search functionality
> Ease of incorporating working tested samples
> Low or no cost licensing of tool chain
> Community collaboration
> Automation
>
> Thanks!
> Anne
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.openstack.org/pipermail/openstack-docs/attachments/20140313/dc186bb2/attachment-0001.html>