Generate your team's road-maps from structured data
This project is designed to make visualizing and tweaking your road maps as easy and straightforward as possible. There are a number of good options out there, including PowerPoint, Visio, LucidChart, Draw.io, GraphViz and just plain old lists - however none of them have made me particularly excited about drawing up our team's road maps and many of them make future edits difficult.
The goal here is to change that, by defining your road map in everyone's least loved markup language: YAML. An example road map might look something like the following.
The easiest way to get started viewing your road map is to output a GraphViz DOT file which can be rendered using any GraphViz renderer, like GraphViz Online. To do so, you'll need Go installed on your machine and then you can simply run:
# Install the tool
go install github.com/SierraSoftworks/roadmap/tools/roadmap-graphviz@latest# Run the tool
roadmap-graphviz --in my-roadmap.yml -out my-roadmap.dotDrop the DOT file into your GraphViz renderer of choice and you're good to go!
title: Example Road Mapdescription: | This is an example of what a road map might look like.authors:
- name: Benjamin Pannellemail: contact@sierrasoftworks.comtimeline:
- date: 2021-04-21title: Project Startdescription: This is when we will start working on the project, get the team ready!objectives:
- title: Market Dominancedescription: | Provide actionable analytics drawn from big data to improve our brand identity in the advertainment sector, maximizing clickbait and establishing ourselves as a disruptor in this industry.milestones:
- id: teamtitle: Build the Teamdescription: We don't yet have anyone, that's not gonna work...deliverables:
- title: Team Leadstate: TODOrequirement: MUSTdescription: This person needs to know enough about this domain to be able to run with the project.
- title: Senior Engineer 1
- title: Intern 1..50description: This should be cheaper than hiring a proper team (right?).
- id: donetitle: Finish the Projectdescription: We don't need other milestones, do we?dependencies:
- teamdeliverables:
- title: MVPdescription: Who needs a polished product? Let's just ship the MVP and call it done.
- title: Marketing
- title: VC Funding
- title: Yachtreference: https://lmgtfy.app/?q=yacht&t=i