Menu

I'm Building a Fictional API Just to Document It!
📰

I'm Building a Fictional API Just to Document It!

DEV Community: sass·Joyce Foster·2 days ago
#ATpIHOfm
#devtosass#devto#dev#docs#troyal
Reading 0:00
15s threshold

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…

Continue reading — create a free account

Join HashtagPLUS to read full articles, follow hashtags, vote, and join the conversation.