Is GraphQL really self-documenting?
Resources from my GraphQL documentation talk at API the Docs conference on 9th November 2018.
Description of my talk:
"Developers are raving about how GraphQL is “self-documenting” and how it doesn’t need docs but I disagree. I want to debunk the self-documenting myth, talk about why naming is so important in GraphQL and explain why technical writers still have a key role to play in its documentation."
📑 Blog posts
- "My Code is Self-documenting" - Write the Docs co-founder Eric Holscher.
- "Why you should document your self-documenting code" - Developer Oleksandr Kaleniuk's post from Hackernoon.
- "Does GraphQL reduce the need for documentation?" - Technical writer Chris Ward's blog post from Codeship.
- Lessons from 4 Years of GraphQL - GraphQL co-creator Lee Byron speaking about how naming matters at the GraphQL Summit in 2016.
- Documenting GraphQL at Shopify - Shopify technical writer Andrew Johnston's talk at API the Docs London in 2017.
- Life is hard and so is learning GraphQL - Developer and former technical writer Carolyn Stransky speaking at GraphQL Finland in 2018.
📚 Other resources
- Interview with GraphQL co-creator Lee Byron - My interview with GraphQL co-creator Lee Byron for the Nordic APIs website.
- GraphQL website - The GraphQL official website.
- Who's using GraphQL? - GraphQL's published list of users.
- GraphQL Spec - Link to the latest GraphQL specification.
- Public GraphQL APIs and tools - My repo of public GraphQL APIs and some of the available documentation tools.
- Extensive list of GraphQL APIs - API Gurus extensive list of GraphQL APIs with links to public-facing documentation.
- Definition of self-documenting code - PC Magazine's definition of self-documenting code.