Skip to content
This repository has been archived by the owner on Sep 24, 2022. It is now read-only.

Added Proto Personas #91

Closed
wants to merge 1 commit into from
Closed

Added Proto Personas #91

wants to merge 1 commit into from

Conversation

totewar
Copy link

@totewar totewar commented Dec 9, 2019

  • added an about page
  • added proto-personas for developers, non-native english humans, newbie wordsmiths and leaders

- added an about page
- added proto-personas for developers, non-native english humans, newbie wordsmiths and leaders
@totewar
Copy link
Author

totewar commented Dec 12, 2019

This is my commit message

Signed-off-by: Sanket Totewar [email protected]

@totewar totewar requested review from archaeogeek and camerons and removed request for archaeogeek December 12, 2019 09:06
@totewar totewar changed the title First commit Added Proto Personas Dec 12, 2019
@camerons
Copy link
Member

As mentioned in weekly meeting today:

  • I think discussing personas is a good idea, but material so far doesn't look polished or well researched.
  • Our material should be a summary of international best practices.
  • We should start by researching to find best practices in the world.
  • We should invite the best people in the world to review our best practices, (and not consider our material ready until we have got such review.)
  • People using our material should have confidence that our material is best practice, which they can see from our references.
  • Our material that is included in templates should be distilled down to bare essentials for our target audience - we don't want our audience to have to read all the research, just what they need to know.

@emckean
Copy link
Contributor

emckean commented Dec 12, 2019 via email

@cwcromwell
Copy link
Contributor

cwcromwell commented Jan 18, 2020

Personas are a great idea.
I don't know where these would go (on the site or only in the repo?) but they are the best way I've seen to address the intentions of the project. I wish we'd had these in the beginning.

I would suggest changes from what I see in these examples.

  • I would place less emphasis on the fear of writing. Some developers may have a fear of writing, and we can help them to get started. These templates help anyone who wants to write documentation, however, including skilled technical writers. They're probably more interested in talking about templates than anyone. (They're not only for beginners or the fearful.)
  • I wouldn't say that we help developers understand what contents their documentation requires so that they can coach others (as one of these personas states). It's more like we help them understand so they can simply write better documentation. This is important, because our job is easier if we have the same goal for all the personas: that they understand what is required and write better documentation.
  • We need a persona for the technical writer. Technical writers need a model they can use to verify the the documentation is complete when they join a new project; and for reference when they start a new project..
  • The section about newbie writers actually applies to all personas. The main benefit of using templates is that they ensure that you won't leave out important information, thereby frustrating your end users. The benefits could be summarized in a more general way by saying something like, "I want the software to become easier for customers to use and less frustrating, thereby making learning easier, adoption faster and subscription renewals more likely."
  • The goals described in the "non-native speaker" persona appear to be outside of the scope of this project. We should stick to minimum-viable-docset architecture and completeness of docs.

@mgan59
Copy link
Contributor

mgan59 commented May 20, 2020

Touched on the idea of the Jobs-To-Be-Done framework as it ties back to scoping as audience
JobStory2

@emckean
Copy link
Contributor

emckean commented May 20, 2020

after discussion on 5/20 we're going to close this and create an issue for further discussion: #133

@emckean emckean closed this May 20, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants