Perhaps some one is familiar with the various technologies involved here (for the most part), and doesn't need to - or have patience or bandwidth for - read(ing) a ton of documentation. Perhaps something like this (which is admittedly messy and incomplete, just to give you an idea):
Quickstart
First, install the following. Examples shown for Homebrew on OS X.
brew tap starkandwayne/cf && brew update
brew install spruce awscli terraform direnv go # ...
Ed. Note: I suggest including reference tables in documentation so glancers/skimmers (which let's face it, is everybody these days, information overload) can grok the details they need quickly. Here's an example:
Property
Format or Value
Notes
Name
Any regular string is fine. Example: "Bob"
n/a
Member of
A group with the policy named WHATEVER applied
PowerUsers
/ed. note
Set up an IAM user and group, or use an existing one
Name should follow FORMAT
Should be a member of a group whose name follows FORMAT
Said group should have POLICYNAME policy attached to it;
If you can't attach that whole policy to the group, at least grant the group that this user belongs to the following permissions: `[...enumerate list of all necessary permissions/rights the IAM user will need to run this code...]
See THISDOC for more details on security practices and limiting access to keep your existing account secure by using IAM.
Example
...put some examples here for quick reference...
Ed. Note - provide an example in two formats for clarity:
(1) A screenshot of the AWS dashboard (it's ok if this gets somewhat outdated, it'll provide enough contextual reference to help the user "get it";
(2) A plain-text representation of the object in Amazon's IAM configuration language, for example, or perhaps a YAML snippet, or whatever.
It's of great importance that code snippets absolutely show the filename and location where that snippet should be on disk or in the project where applicable, as well as _provide some notion of _where* in the file that snippet should go* (context). Just a few notes of comments is enough.
If you don't already have a public/private key pair associated with this user, you can use Amazon's AWS dashboard (todo: provide link) to create one. Amazon will automatically keep the public key and allow you to download, once and only once (since it doesn't save this for obvious reasons), the private key.
The key on Amazon's end must be named LIKE THIS, or at least following THIS FORMAT
On your local disk, the private key file should be named according to FORMAT or given the filename, bosh.pem (or whatever the right name is)
You get the idea. Quickstart docs are often the best for two reasons: first, they're short and to the point. Second, if you need more than a quickstart document, your product is too complex and needs to be simplified in some way.
Perhaps some one is familiar with the various technologies involved here (for the most part), and doesn't need to - or have patience or bandwidth for - read(ing) a ton of documentation. Perhaps something like this (which is admittedly messy and incomplete, just to give you an idea):
Quickstart
First, install the following. Examples shown for Homebrew on OS X.
WHATEVERappliedSee
THISDOCfor more details on security practices and limiting access to keep your existing account secure by using IAM.Example
...put some examples here for quick reference...
LIKE THIS, or at least followingTHIS FORMATFORMATor given the filename,bosh.pem(or whatever the right name is)You get the idea. Quickstart docs are often the best for two reasons: first, they're short and to the point. Second, if you need more than a quickstart document, your product is too complex and needs to be simplified in some way.