Commit cc5fb05c authored by Jonathan Wilkes's avatar Jonathan Wilkes
Browse files

added a first draft of a season of docs information page

parent d29be482
Purr Data Season of Docs
------------------------
Greetings Documenters!
We at Purr Data are looking forward to participating in Season of
Docs. We're currently in the process of overhauling our documentation system.
We're looking for help both testing and editing docs in the new system, as
well as doing a much needed audit of the readability and clarity of the
documentation for an audience of new users who generally have little programming
experience.
Here are the key points about our doc system:
* current system has some finicky restrictions on text, and it requires
the writer to manually move text around on a page to format correctly and
avoid overlapping text. Bad stuff!
* new system will allow writers to write text in a simple markdown file--
either free text, or-- preferably-- using a simple, standard template that
ensures each part of the class or feature has been covered.
Challenges for documenters
--------------------------
* help us improve our documentation to better accommodate first-time users and
non-native speakers
* if you speak a second language, adding a few documentation files in your
language to show other speakers of that language how to write documentation
in our new system.
* provide fresh eyes for documentation that mostly written by insiders who
can use insider terminology that may not even be clear to veteran users
* ensure that our conversion from the old finicky inline comments to markdown
didn't introduce any errors
* provide feedback on the ergonomics of both entering a new piece of
documentation using our system, and editing existing documentation. How does
it feel to create/edit documentation in our system? Do any aspects of our
system get in the way?
* provide us feedback on how well our search functionality works to display
meaningful results in a clear and concise way.
Under Construction
------------------
We're in the process of applying to be an accepted organization this year. As
we flesh out our project proposal, we'll add more details here regarding the
specifics of our timeline, budget, and metrics.
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment