What's in here (so far):
- A manifesto outlining our team's mission and values
- Staffing and Hiring including how we recruit and hire new team members plus some sample job descriptions and interview questions for screening candidates.
- How we work including our internal process, what we've learned about working as a remote team, the tools we use and notes on how we conduct meetings
- How to work with us including the general guidelines for how to work with us effectively, services we offer to INN members, details of our paid consulting program, intake documents for new projects and a code of conduct for contributing to our open source projects.
- Style guides for code and design/ui elements.
- Projects we work on with descriptions of each project and relevant resources.
- Checklists to help keep us organized.
- Our Communications Strategy
What is not (and will not) be in here:
- Documentation for Largo and some of our other large projects which will typically be kept with their respective project repos as well as on Read the Docs.
- Documentation for our other apps/tools/etc. (e.g. our deployment tools or our responsive tables rig) that are on the smaller side will typically reside within those repos directly as a readme file at the root of the repository.
Important Note: Nothing in these docs supercedes what you'll find in the INN employee manual. Always refer to that for any personnel, hiring, payroll, etc. issues.
These docs draw on (and sometimes straight up steal) excellent work from teams that have come before us. Here are a few of our sources of inspiration:
- ProPublica's News App and Data Style Guides
- The NPR Visuals Team's app template, coding best practices and manifesto
- Guides and Process Docs from The Chicago Tribune's News Apps Team
- MinnPost's UI Style Guide
All of these documents are licensed under a Creative Commons BY-NC 3.0 license. You are free to share and to remix them (as long as you credit us) but please don't use them commercially without permission.
We welcome contributions and suggestions to help us improve any of these documents. Please start by reading our contribution guidelines.
And then, to contribute your changes:
- Fork this repo
- Create a branch (git checkout -b my-branch)
- Stage and commit your changes (git commit -am 'description of my changes')
- Push the changes to your fork (git push origin my-branch)
- Submit a pull request to the parent repo
Additionally, you can create issues on this repo to suggest changes or improvements. And of course you can always email us: nerds@inn.org.
The INN news apps and technology team is:
- Adam Schweigert (@aschweig), Senior Director of Product and Technology
- Kaeti Hinck (@kaeti), Design Director
- Denise Malan (@denisemalan), Director of Data Services
- Ryan Nagle (@ryannagle), News Apps Developer
- Nick Bennett (yoyoohrho), News Apps Developer
- Meredith Melragon (@meredithm), Support Specialist
- Will Haynes (@willhaynes), Apprentice News Apps Developer
- Ben Keith (@benlkeith), Apprentice News Apps Developer
Version 0.1
- Initial Release