[Openstack-docs] Target audience

Andreas Jaeger aj at suse.com
Tue May 20 07:36:30 UTC 2014


On 05/20/2014 07:18 AM, Anne Gentle wrote:
> Thanks for analyzing Andreas and Randy!
> 
> I like these three simple personas below.
> 
> Alice the admin
> Alice is an administrator who is responsible for maintaining (and
> securing) the OpenStack cloud installation. She has many years of
> experience with Linux systems administration.
>
> Darren the deployer
> Darren is responsible for doing the initial OpenStack deployment on the
> host machines.
> Emile the end-user
> Emile uses the cloud to do software development inside of the virtual
> machines. She uses the command-line tools because she finds it quicker
> than using the dashboard.

Yes, these are fine - but let's rename Alice since Alice and Bob are the
two persons used in the Security Guide explaining the two different setups.

> To me, Emile is a useful persona because she uses user tools and
> developer tools -- and I do see a lot of blending across user/dev tools.
> Andreas, the user we haven't yet started to document for is the
> application devops role, the operator who would monitor applications in
> the cloud. They might be super specialized for monitoring of the VMs
> themselves.
> 
> But I'm not sure whether there's a fourth persona who does planning and
> setup, what do you all think? Archie the architect? 

So, the OPS guide would be for Archie?

> We also don't have to be super pattern-based, we can just write a
> section describing the audience for each guide. 

;)

Andreas

> 
> On Mon, May 19, 2014 at 3:41 PM, Andreas Jaeger <aj at suse.com
> <mailto:aj at suse.com>> wrote:
> 
>     We had some discussion about target audience for each guide at the
>     OpenStack summit and Anne filed this bug:
>     https://bugs.launchpad.net/openstack-manuals/+bug/1319394 . As a first
>     step, I've went over all guides and categorized them according to target
>     audience and then copied all the current abstracts together. Is the
>     following accurate?
> 
>     Andreas
> 
>     Overview of personas/target audience:
> 
>     Operations Guide
>     Cloud Administrator Guide
>     Configuration Reference
>     HA Guide
>     Install Guide
>     Security Guide
>     Admin User Guide
> 
>     These guides target cloud administrators who sets up an OpenStack
>     cloud and configures the OpenStack services.
> 
>     End User Guide
>     Image Guide
> 
>     These guide targets users using an OpenStack cloud.
> 
>     CLI Reference
> 
>     This guide targets both cloud administrators and users using an
>     OpenStack cloud.
> 
>     Not covered personas:
> 
>     Developer writing applications running in an OpenStack Cloud.
> 
>     ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
>     Detailed information - copy of current abstract:
> 
>     Install Guide
> 
>     The OpenStack® system consists of several key projects that you
>     install separately but that work together depending on your cloud
>     needs. These projects include Compute, Identity Service, Networking,
>     Image Service, Block Storage, Object Storage, Telemetry,
>     Orchestration, and Database. You can install any of these projects
>     separately and configure them stand-alone or as connected
>     entities. This guide shows you how to install OpenStack by using
>     packages on openSUSE through the Open Build Service Cloud
>     repository. Explanations of configuration options and sample
>     configuration files are included.
> 
> 
>     Operations Guide
> 
>     This book provides information about designing and operating OpenStack
>     clouds.
> 
>     Cloud Administrator Guide
> 
>     OpenStack offers open source software for cloud administrators to
>     manage and troubleshoot an OpenStack cloud.
> 
>     Configuration Reference
> 
>     This document is for system administrators who want to look up
>     configuration options. It contains lists of configuration options
>     available with OpenStack and uses auto-generation to generate options
>     and the descriptions from the code for each project. It includes
>     sample configuration files.
> 
>     HA Guide
> 
>     No abstract given.
> 
>     Security Guide
> 
>     This book provides best practices and conceptual information about
>     securing an OpenStack cloud.
> 
>     Admin User Guide
> 
>     OpenStack is an open source cloud computing platform for public and
>     private clouds. A series of interrelated projects deliver a cloud
>     infrastructure solution. This guide shows OpenStack admin users how to
>     create and manage resources in an OpenStack cloud with the OpenStack
>     dashboard or OpenStack client commands.
> 
> 
>     End User Guide
> 
>     OpenStack is an open-source cloud computing platform for public and
>     private clouds. A series of interrelated projects deliver a cloud
>     infrastructure solution. This guide shows OpenStack end users how to
>     create and manage resources in an OpenStack cloud with the OpenStack
>     dashboard and OpenStack client commands.
> 
>     Image Guide
> 
>     This guide describes how to obtain, create, and modify virtual machine
>     images that are compatible with OpenStack.
> 
>     CLI Reference
> 
>     This guide documents the OpenStack command-line clients.
> 
>     --
>      Andreas Jaeger aj@{suse.com <http://suse.com>,opensuse.org
>     <http://opensuse.org>} Twitter/Identica: jaegerandi
>       SUSE LINUX Products GmbH, Maxfeldstr. 5, 90409 Nürnberg, Germany
>        GF: Jeff Hawn,Jennifer Guild,Felix Imendörffer,HRB16746 (AG Nürnberg)
>         GPG fingerprint = 93A3 365E CE47 B889 DF7F  FED1 389A 563C C272 A126
> 
>     _______________________________________________
>     Openstack-docs mailing list
>     Openstack-docs at lists.openstack.org
>     <mailto:Openstack-docs at lists.openstack.org>
>     http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs
> 
> 


-- 
 Andreas Jaeger aj@{suse.com,opensuse.org} Twitter: jaegerandi
  SUSE LINUX Products GmbH, Maxfeldstr. 5, 90409 Nürnberg, Germany
   GF: Jeff Hawn,Jennifer Guild,Felix Imendörffer,HRB16746 (AG Nürnberg)
    GPG fingerprint = 93A3 365E CE47 B889 DF7F  FED1 389A 563C C272 A126



More information about the Openstack-docs mailing list