this example repository<\/a> with a docs folder structure and documentation templates that you can copy into your own project.<\/p>\n<\/aside>\n<\/body><\/html>\n","protected":false},"excerpt":{"rendered":"Learn why and how you should write docs for your project with the Di\u00e1taxis framework.<\/p>\n","protected":false},"author":2299,"featured_media":85979,"comment_status":"closed","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"_gh_post_show_toc":"yes","_gh_post_is_no_robots":"","_gh_post_is_featured":"yes","_gh_post_is_excluded":"","_gh_post_is_unlisted":"","_gh_post_related_link_1":"","_gh_post_related_link_2":"","_gh_post_related_link_3":"","_gh_post_sq_img":"","_gh_post_sq_img_id":"","_gh_post_cta_title":"","_gh_post_cta_text":"","_gh_post_cta_link":"","_gh_post_cta_button":"","_gh_post_recirc_hide":"","_gh_post_recirc_col_1":"","_gh_post_recirc_col_2":"","_gh_post_recirc_col_3":"","_gh_post_recirc_col_4":"","_featured_video":"","_gh_post_additional_query_params":"","_jetpack_newsletter_access":"","_jetpack_dont_email_post_to_subs":false,"_jetpack_newsletter_tier_id":0,"_jetpack_memberships_contains_paywalled_content":false,"_jetpack_feature_clip_id":0,"_jetpack_memberships_contains_paid_content":false,"footnotes":"","jetpack_publicize_message":"","jetpack_publicize_feature_enabled":true,"jetpack_social_post_already_shared":true,"jetpack_social_options":{"image_generator_settings":{"template":"highway","enabled":false},"version":2},"_wpas_customize_per_network":false,"jetpack_post_was_ever_published":false,"_links_to":"","_links_to_target":""},"categories":[3298],"tags":[],"coauthors":[3531,3689],"class_list":["post-87836","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-developer-skills"],"yoast_head":"\n
Documentation done right: A developer\u2019s guide - The GitHub Blog<\/title>\n<meta name=\"description\" content=\"Learn why and how you should write docs for your project with the Di\u00e1taxis framework.\" \/>\n<meta name=\"robots\" content=\"index, follow, max-snippet:-1, max-image-preview:large, max-video-preview:-1\" \/>\n<link rel=\"canonical\" href=\"https:\/\/github.blog\/developer-skills\/documentation-done-right-a-developers-guide\/\" \/>\n<meta property=\"og:locale\" content=\"en_US\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"Documentation done right: A developer\u2019s guide\" \/>\n<meta property=\"og:description\" content=\"Learn why and how you should write docs for your project with the Di\u00e1taxis framework.\" \/>\n<meta property=\"og:url\" content=\"https:\/\/github.blog\/developer-skills\/documentation-done-right-a-developers-guide\/\" \/>\n<meta property=\"og:site_name\" content=\"The GitHub Blog\" \/>\n<meta property=\"article:published_time\" content=\"2025-05-14T16:00:00+00:00\" \/>\n<meta property=\"article:modified_time\" content=\"2025-05-15T15:09:46+00:00\" \/>\n<meta property=\"og:image\" content=\"https:\/\/github.blog\/wp-content\/uploads\/2025\/03\/github_logo_invertocat_dark_3.png\" \/>\n\t<meta property=\"og:image:width\" content=\"1200\" \/>\n\t<meta property=\"og:image:height\" content=\"630\" \/>\n\t<meta property=\"og:image:type\" content=\"image\/png\" \/>\n<meta name=\"author\" content=\"Brittany Ellich, Sam Browning\" \/>\n<meta name=\"twitter:card\" content=\"summary_large_image\" \/>\n<meta name=\"twitter:label1\" content=\"Written by\" \/>\n\t<meta name=\"twitter:data1\" content=\"Brittany Ellich, Sam Browning\" \/>\n\t<meta name=\"twitter:label2\" content=\"Est. reading time\" \/>\n\t<meta name=\"twitter:data2\" content=\"4 minutes\" \/>\n<script type=\"application\/ld+json\" class=\"yoast-schema-graph\">{\"@context\":\"https:\\\/\\\/schema.org\",\"@graph\":[{\"@type\":\"Article\",\"@id\":\"https:\\\/\\\/github.blog\\\/developer-skills\\\/documentation-done-right-a-developers-guide\\\/#article\",\"isPartOf\":{\"@id\":\"https:\\\/\\\/github.blog\\\/developer-skills\\\/documentation-done-right-a-developers-guide\\\/\"},\"author\":{\"name\":\"Brittany Ellich\",\"@id\":\"https:\\\/\\\/github.blog\\\/#\\\/schema\\\/person\\\/e60f8645e0750138873c1343e325ef15\"},\"headline\":\"Documentation done right: A developer\u2019s guide\",\"datePublished\":\"2025-05-14T16:00:00+00:00\",\"dateModified\":\"2025-05-15T15:09:46+00:00\",\"mainEntityOfPage\":{\"@id\":\"https:\\\/\\\/github.blog\\\/developer-skills\\\/documentation-done-right-a-developers-guide\\\/\"},\"wordCount\":738,\"image\":{\"@id\":\"https:\\\/\\\/github.blog\\\/developer-skills\\\/documentation-done-right-a-developers-guide\\\/#primaryimage\"},\"thumbnailUrl\":\"https:\\\/\\\/github.blog\\\/wp-content\\\/uploads\\\/2025\\\/03\\\/github_logo_invertocat_dark_3.png?fit=1200%2C630\",\"articleSection\":[\"Developer skills\"],\"inLanguage\":\"en-US\"},{\"@type\":\"WebPage\",\"@id\":\"https:\\\/\\\/github.blog\\\/developer-skills\\\/documentation-done-right-a-developers-guide\\\/\",\"url\":\"https:\\\/\\\/github.blog\\\/developer-skills\\\/documentation-done-right-a-developers-guide\\\/\",\"name\":\"Documentation done right: A developer\u2019s guide - The GitHub Blog\",\"isPartOf\":{\"@id\":\"https:\\\/\\\/github.blog\\\/#website\"},\"primaryImageOfPage\":{\"@id\":\"https:\\\/\\\/github.blog\\\/developer-skills\\\/documentation-done-right-a-developers-guide\\\/#primaryimage\"},\"image\":{\"@id\":\"https:\\\/\\\/github.blog\\\/developer-skills\\\/documentation-done-right-a-developers-guide\\\/#primaryimage\"},\"thumbnailUrl\":\"https:\\\/\\\/github.blog\\\/wp-content\\\/uploads\\\/2025\\\/03\\\/github_logo_invertocat_dark_3.png?fit=1200%2C630\",\"datePublished\":\"2025-05-14T16:00:00+00:00\",\"dateModified\":\"2025-05-15T15:09:46+00:00\",\"author\":{\"@id\":\"https:\\\/\\\/github.blog\\\/#\\\/schema\\\/person\\\/e60f8645e0750138873c1343e325ef15\"},\"description\":\"Learn why and how you should write docs for your project with the Di\u00e1taxis framework.\",\"breadcrumb\":{\"@id\":\"https:\\\/\\\/github.blog\\\/developer-skills\\\/documentation-done-right-a-developers-guide\\\/#breadcrumb\"},\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\\\/\\\/github.blog\\\/developer-skills\\\/documentation-done-right-a-developers-guide\\\/\"]}]},{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\\\/\\\/github.blog\\\/developer-skills\\\/documentation-done-right-a-developers-guide\\\/#primaryimage\",\"url\":\"https:\\\/\\\/github.blog\\\/wp-content\\\/uploads\\\/2025\\\/03\\\/github_logo_invertocat_dark_3.png?fit=1200%2C630\",\"contentUrl\":\"https:\\\/\\\/github.blog\\\/wp-content\\\/uploads\\\/2025\\\/03\\\/github_logo_invertocat_dark_3.png?fit=1200%2C630\",\"width\":1200,\"height\":630},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\\\/\\\/github.blog\\\/developer-skills\\\/documentation-done-right-a-developers-guide\\\/#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Home\",\"item\":\"https:\\\/\\\/github.blog\\\/\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Developer skills\",\"item\":\"https:\\\/\\\/github.blog\\\/developer-skills\\\/\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Documentation done right: A developer\u2019s guide\"}]},{\"@type\":\"WebSite\",\"@id\":\"https:\\\/\\\/github.blog\\\/#website\",\"url\":\"https:\\\/\\\/github.blog\\\/\",\"name\":\"The GitHub Blog\",\"description\":\"Updates, ideas, and inspiration from GitHub to help developers build and design software.\",\"potentialAction\":[{\"@type\":\"SearchAction\",\"target\":{\"@type\":\"EntryPoint\",\"urlTemplate\":\"https:\\\/\\\/github.blog\\\/?s={search_term_string}\"},\"query-input\":{\"@type\":\"PropertyValueSpecification\",\"valueRequired\":true,\"valueName\":\"search_term_string\"}}],\"inLanguage\":\"en-US\"},{\"@type\":\"Person\",\"@id\":\"https:\\\/\\\/github.blog\\\/#\\\/schema\\\/person\\\/e60f8645e0750138873c1343e325ef15\",\"name\":\"Brittany Ellich\",\"image\":{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\\\/\\\/secure.gravatar.com\\\/avatar\\\/898c7098afd46e9e72a15974036000713038f02811949b44f887f464c688bcdb?s=96&d=mm&r=gb24070c4c5165a92feefb185827d649a\",\"url\":\"https:\\\/\\\/secure.gravatar.com\\\/avatar\\\/898c7098afd46e9e72a15974036000713038f02811949b44f887f464c688bcdb?s=96&d=mm&r=g\",\"contentUrl\":\"https:\\\/\\\/secure.gravatar.com\\\/avatar\\\/898c7098afd46e9e72a15974036000713038f02811949b44f887f464c688bcdb?s=96&d=mm&r=g\",\"caption\":\"Brittany Ellich\"},\"description\":\"Brittany is a software engineer at GitHub, working in Platform and Enterprise.\",\"url\":\"https:\\\/\\\/github.blog\\\/author\\\/brittanyellich\\\/\"}]}<\/script>\n<!-- \/ Yoast SEO Premium plugin. -->","yoast_head_json":{"title":"Documentation done right: A developer\u2019s guide - The GitHub Blog","description":"Learn why and how you should write docs for your project with the Di\u00e1taxis framework.","robots":{"index":"index","follow":"follow","max-snippet":"max-snippet:-1","max-image-preview":"max-image-preview:large","max-video-preview":"max-video-preview:-1"},"canonical":"https:\/\/github.blog\/developer-skills\/documentation-done-right-a-developers-guide\/","og_locale":"en_US","og_type":"article","og_title":"Documentation done right: A developer\u2019s guide","og_description":"Learn why and how you should write docs for your project with the Di\u00e1taxis framework.","og_url":"https:\/\/github.blog\/developer-skills\/documentation-done-right-a-developers-guide\/","og_site_name":"The GitHub Blog","article_published_time":"2025-05-14T16:00:00+00:00","article_modified_time":"2025-05-15T15:09:46+00:00","og_image":[{"width":1200,"height":630,"url":"https:\/\/github.blog\/wp-content\/uploads\/2025\/03\/github_logo_invertocat_dark_3.png","type":"image\/png"}],"author":"Brittany Ellich, Sam Browning","twitter_card":"summary_large_image","twitter_misc":{"Written by":"Brittany Ellich, Sam Browning","Est. reading time":"4 minutes"},"schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"Article","@id":"https:\/\/github.blog\/developer-skills\/documentation-done-right-a-developers-guide\/#article","isPartOf":{"@id":"https:\/\/github.blog\/developer-skills\/documentation-done-right-a-developers-guide\/"},"author":{"name":"Brittany Ellich","@id":"https:\/\/github.blog\/#\/schema\/person\/e60f8645e0750138873c1343e325ef15"},"headline":"Documentation done right: A developer\u2019s guide","datePublished":"2025-05-14T16:00:00+00:00","dateModified":"2025-05-15T15:09:46+00:00","mainEntityOfPage":{"@id":"https:\/\/github.blog\/developer-skills\/documentation-done-right-a-developers-guide\/"},"wordCount":738,"image":{"@id":"https:\/\/github.blog\/developer-skills\/documentation-done-right-a-developers-guide\/#primaryimage"},"thumbnailUrl":"https:\/\/github.blog\/wp-content\/uploads\/2025\/03\/github_logo_invertocat_dark_3.png?fit=1200%2C630","articleSection":["Developer skills"],"inLanguage":"en-US"},{"@type":"WebPage","@id":"https:\/\/github.blog\/developer-skills\/documentation-done-right-a-developers-guide\/","url":"https:\/\/github.blog\/developer-skills\/documentation-done-right-a-developers-guide\/","name":"Documentation done right: A developer\u2019s guide - The GitHub Blog","isPartOf":{"@id":"https:\/\/github.blog\/#website"},"primaryImageOfPage":{"@id":"https:\/\/github.blog\/developer-skills\/documentation-done-right-a-developers-guide\/#primaryimage"},"image":{"@id":"https:\/\/github.blog\/developer-skills\/documentation-done-right-a-developers-guide\/#primaryimage"},"thumbnailUrl":"https:\/\/github.blog\/wp-content\/uploads\/2025\/03\/github_logo_invertocat_dark_3.png?fit=1200%2C630","datePublished":"2025-05-14T16:00:00+00:00","dateModified":"2025-05-15T15:09:46+00:00","author":{"@id":"https:\/\/github.blog\/#\/schema\/person\/e60f8645e0750138873c1343e325ef15"},"description":"Learn why and how you should write docs for your project with the Di\u00e1taxis framework.","breadcrumb":{"@id":"https:\/\/github.blog\/developer-skills\/documentation-done-right-a-developers-guide\/#breadcrumb"},"inLanguage":"en-US","potentialAction":[{"@type":"ReadAction","target":["https:\/\/github.blog\/developer-skills\/documentation-done-right-a-developers-guide\/"]}]},{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/github.blog\/developer-skills\/documentation-done-right-a-developers-guide\/#primaryimage","url":"https:\/\/github.blog\/wp-content\/uploads\/2025\/03\/github_logo_invertocat_dark_3.png?fit=1200%2C630","contentUrl":"https:\/\/github.blog\/wp-content\/uploads\/2025\/03\/github_logo_invertocat_dark_3.png?fit=1200%2C630","width":1200,"height":630},{"@type":"BreadcrumbList","@id":"https:\/\/github.blog\/developer-skills\/documentation-done-right-a-developers-guide\/#breadcrumb","itemListElement":[{"@type":"ListItem","position":1,"name":"Home","item":"https:\/\/github.blog\/"},{"@type":"ListItem","position":2,"name":"Developer skills","item":"https:\/\/github.blog\/developer-skills\/"},{"@type":"ListItem","position":3,"name":"Documentation done right: A developer\u2019s guide"}]},{"@type":"WebSite","@id":"https:\/\/github.blog\/#website","url":"https:\/\/github.blog\/","name":"The GitHub Blog","description":"Updates, ideas, and inspiration from GitHub to help developers build and design software.","potentialAction":[{"@type":"SearchAction","target":{"@type":"EntryPoint","urlTemplate":"https:\/\/github.blog\/?s={search_term_string}"},"query-input":{"@type":"PropertyValueSpecification","valueRequired":true,"valueName":"search_term_string"}}],"inLanguage":"en-US"},{"@type":"Person","@id":"https:\/\/github.blog\/#\/schema\/person\/e60f8645e0750138873c1343e325ef15","name":"Brittany Ellich","image":{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/secure.gravatar.com\/avatar\/898c7098afd46e9e72a15974036000713038f02811949b44f887f464c688bcdb?s=96&d=mm&r=gb24070c4c5165a92feefb185827d649a","url":"https:\/\/secure.gravatar.com\/avatar\/898c7098afd46e9e72a15974036000713038f02811949b44f887f464c688bcdb?s=96&d=mm&r=g","contentUrl":"https:\/\/secure.gravatar.com\/avatar\/898c7098afd46e9e72a15974036000713038f02811949b44f887f464c688bcdb?s=96&d=mm&r=g","caption":"Brittany Ellich"},"description":"Brittany is a software engineer at GitHub, working in Platform and Enterprise.","url":"https:\/\/github.blog\/author\/brittanyellich\/"}]}},"jetpack_publicize_connections":[],"jetpack_featured_media_url":"https:\/\/github.blog\/wp-content\/uploads\/2025\/03\/github_logo_invertocat_dark_3.png?fit=1200%2C630","jetpack_shortlink":"https:\/\/wp.me\/pamS32-mQI","jetpack_sharing_enabled":true,"_links":{"self":[{"href":"https:\/\/github.blog\/wp-json\/wp\/v2\/posts\/87836","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/github.blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/github.blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/github.blog\/wp-json\/wp\/v2\/users\/2299"}],"replies":[{"embeddable":true,"href":"https:\/\/github.blog\/wp-json\/wp\/v2\/comments?post=87836"}],"version-history":[{"count":4,"href":"https:\/\/github.blog\/wp-json\/wp\/v2\/posts\/87836\/revisions"}],"predecessor-version":[{"id":87937,"href":"https:\/\/github.blog\/wp-json\/wp\/v2\/posts\/87836\/revisions\/87937"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/github.blog\/wp-json\/wp\/v2\/media\/85979"}],"wp:attachment":[{"href":"https:\/\/github.blog\/wp-json\/wp\/v2\/media?parent=87836"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/github.blog\/wp-json\/wp\/v2\/categories?post=87836"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/github.blog\/wp-json\/wp\/v2\/tags?post=87836"},{"taxonomy":"author","embeddable":true,"href":"https:\/\/github.blog\/wp-json\/wp\/v2\/coauthors?post=87836"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}