I'm building a fictional product just so I can document it.
I'm a technical writer, and I want my portfolio to reflect my process of documentation, not just the finished docs.
So, I'm creating one from scratch. It's called TROYAL, a fictional B2B SaaS API for tracking music and film royalties.
Why royalties? I’ve heard a lot about artists and labels being at loggerheads over Royalties, Ownership of Work, Percentages,
or simply about payments matching their contract. This has led to numerous disputes and made several artists go independent. It’s definitely a real problem worth building around, even if it's only on paper.
Here's what I've done so far:
Product brief- Who Troyal is for (labels, entertainment law firms and management companies), what problem it solves, and what it does.
API design- I mapped out the resources, endpoints, methods, authentication and responses, starting with works, ownership splits and royalty statements.
README- The front door of the project, so anyone landing on the repo knows what it is in under a minute.
All of it is public on GitHub, written in Markdown.
Next up: a Getting Started guide, an OpenAPI spec, a Jira board to track the doc work, and a docs site.
I'll share each step here as I go, including the messy parts. Follow along if you'd like to see how a docs project comes together.
Troyal is fictional. The documentation is real.
Top comments (1)
Amazingggg!😍❤️❤️❤️🌸🥳🥹✨😭🥳🌸🌸🌸🎈