What kinds of documentation do we want?

[danielballan]

Or, to put it another way, what are the audiences for our documentation?

On-boarding someone into the entirety of the project is a major undertaking and still a moving target, so I don't think we should yet attempt to do that in writing. Instead I think we should work on sections targeted to specific audiences trying to work on a well-defined piece of the project, such as:

• Analysis/researchers who want to use data science / text analysis tools to study the collection snapshots and diffs exposed by Scanner
• Potential contributors who want to improve our differs
• Potential contributors who want to improve our UI
• Technical folks working at potential partner orgs or news organizations who want to understand the current capability and roadmap of the tools
• Trusted contributors who are helping with our deployment (i.e. updating production or debugging an outage)
• Outside organizations who want to stand up and maintain their own separate deployment of Scanner (e.g. Web Integrity Project)

I have left out a couple components here (the Rails server, the import system, the diffing server) because I think working on those pieces requires a fairly comprehensive understanding of the plumbing.

What other audiences should we have in mind?

[danielballan]

attn @dcwalk, @titaniumbones

[stale]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed in seven days if no further activity occurs. If it should not be closed, please comment! Thank you for your contributions.