The data team routinely runs out mapping projects like updating US roads from fresh government data, retagging sidewalks or adding turn lanes. This guide will help you successfully accomplish any mapping project you start.
Use this as a checklist for whenever you lead a mapping project at Mapbox.
Every mapping project has a lead, a Mapbox team member running point on the mapping project. As the lead for a mapping project you are responsible for its successful completion. This guide is meant to help you accomplish this.
- Background provides important context for the project. Why should it be done? What do you plan to achieve? Include other relevant information that directly concerns the project.
- Priorities help keep the project in focus. If the priorities are not clear at the time of opening the ticket, define an action plan to identify these priorities.
- Ensure it is clear what finishing looks like. We shouldn't ever embark on mapping projects that don't have a clear finish line.
At this stage, make sure it is 100% clear why we are embarking on the mapping project. Any project starts with a relevant backstory that can help set the context for a new initiative.
The Mapbox data team will coordinate all OSM projects in the open mapping repository by default.
- Communicate early with the team to fill in any knowledge gaps. A quick slack question to a team member or community members on IRC can save hours of research.
- Document resources you feel will be important for the project. Any new knowledge shared with the team is invaluable for future work.
- Do thorough research to ensure you are building on top of prior work and findings. This helps build smarter.
- Share regularly your ideas and findings with others. This can help shape solid ideas and avoid obvious traps.
- Keep it simple and clear
- Create a master ticket in the mapping repository. This ticket captures mapping priorities, workflows, available resources, and instructions required to complete the project. The master ticket will also serve as a place for discussion with other interested mappers on the task at hand. Outline of the master ticket:
- Identify the mapping project lead to make sure key milestones are achieved, and keep open communication with the rest of the community.
- Scope the level of team involvement in the project, and identify next actions at the end of the involvement.
- Document all relevant tools, data/imagery sources, instructions and other resources critical to completing the project.
Here is sample master ticket to help you get started - [SF Buildings] Tracing buildings in San Francisco Peninsula [trial]
For experimental project, it is important to formulate a workflow by conducting controlled trials:
- Assemble a small team with experience relevant to the project
- Identify the best workflow to tackle the mapping project
- Identify and involve active members from the OSM community to offer external advice, review the workflows and identify best practices
- Thoroughly document the selected workflow (example)
- Ensure tooling is in place. This is the time to implement any necessary tool improvements.
- Assemble a team of mappers. This should be as many people as possible, to finish tasks quickly rather than spreading out the team over many tasks.
- Provide a verbal task briefing to the mapping team walking through the documentation you assembled in (2).
- Update documentation where needed. Where possible update the OpenStreetMap Wiki.
- Announce the project on IRC and relevant mailing lists for greater visiblity and participation
As we map, make sure we evaluate, update and communicate our work continuously.
- Ensure the team constantly shares pain points in the workflow and ideas for improvements
- Evaluate the workflow daily and make any updates with the required training and announcements to the team
- Post progress statistics and estimates for completion
- Identify additional training requirements and tools to help achieve the project goals effectively
- Ensure regular communication with the OpenStreetMap community via mailing lists and diary posts for constant external review of the project.
- Identify what's left to do; if required, plan a thorough hand over process, and next steps
- Do a final project review with the project team to capture feedback, and observations for future projects.
- Showcase the project on one or more relevant communication channels
- Post a full summary of the project on the external master ticket (include detailed metrics)
- Post a (before/after) visualization to the external master ticket, either as a GIF or a map, to show the team's contribution to the project.
- Close the master ticket, and any other open tickets that specifically deal with your project.
- Add your project to the Completed Projects section in mapping wiki, and link to the external master ticket.
- Update this Mapping Project Guide where it can be improved.