{"adoption": {"forks": 741, "observed_at": "2026-08-28T04:09:34.403932+00:00", "stars": 6029}, "canonical_url": "https://ross.abutalabs.com/products/the-documentation-compendium", "card": {"archived": false, "artifact_type": "learning-resource", "description": "📢 Various README templates & tips on writing high-quality documentation that people want to read.", "domain": ["documentation", "developer-tools", "tutorials", "awesome-lists"], "enriched": true, "function": ["documentation", "markdown"], "health_score": 50, "homepage": null, "language": null, "license": null, "license_family": "other", "maturity": "active", "member_repos": ["race2infinity/The-Documentation-Compendium"], "name": "race2infinity/The-Documentation-Compendium", "platform": ["cross-platform"], "pushed_at": "2025-10-31T18:22:59+00:00", "repo": "race2infinity/The-Documentation-Compendium", "stars": 6029, "tags": ["readme-templates", "technical-writing", "documentation-guide", "boilerplate"], "topics": ["documentation", "documentation-theme", "documentation-template", "technical-writing", "templates", "template-project", "project-documentation", "readme", "readme-template", "guidelines", "readme-bolierplate", "readme-md", "readme-standard", "docs", "readme-first", "awesome", "documentation-tool"], "urls": [], "use_cases": ["find a readme template for my open source project", "learn how to write good documentation", "improve my project's README", "best practices for technical writing", "structure documentation for a GitHub repo", "get tips on writing docs people actually read"], "what_it_is": "A curated collection of README templates, best practices, and tips for writing high-quality software documentation. It serves as a reference guide for developers and technical writers rather than a runnable tool.", "when_to_avoid": ["you need a tool that generates or hosts documentation automatically", "you need API doc generation from code", "you want a documentation site framework like Docusaurus or MkDocs"], "when_to_choose": ["you are starting a new open-source project and need a README structure", "you want curated links and guidelines on technical writing", "you want copy-paste documentation templates"]}, "data_as_of": "2026-08-30T08:39:29.467469+00:00", "members": [{"path": "/products/the-documentation-compendium", "repo": "race2infinity/The-Documentation-Compendium", "role": "main", "score": 54}], "provenance": {"archived": {"kind": "observed", "observed_at": "2026-08-28T04:09:34.403932+00:00", "source": "github"}, "artifact_type": {"confidence": null, "enriched_at": "2026-08-29T17:49:14.006465+00:00", "kind": "inferred", "prompt_version": 1, "sources": [{"content_hash": "0934aac87027433e838ffb3bc1ded2cb1b144b47becf502055da9aa7bd336b90", "fetched_at": "2026-08-28T04:09:34.403932+00:00", "kind": "readme", "missing": false, "url": "https://github.com/race2infinity/The-Documentation-Compendium"}], "taxonomy_version": 1}, "description": {"kind": "observed", "observed_at": "2026-08-28T04:09:34.403932+00:00", "source": "github"}, "domain": {"confidence": null, "enriched_at": "2026-08-29T17:49:14.006465+00:00", "kind": "inferred", "prompt_version": 1, "sources": [{"content_hash": "0934aac87027433e838ffb3bc1ded2cb1b144b47becf502055da9aa7bd336b90", "fetched_at": "2026-08-28T04:09:34.403932+00:00", "kind": "readme", "missing": false, "url": "https://github.com/race2infinity/The-Documentation-Compendium"}], "taxonomy_version": 1}, "enriched": {"inputs": [], "kind": "computed", "method": "enrichment_status"}, "function": {"confidence": null, "enriched_at": "2026-08-29T17:49:14.006465+00:00", "kind": "inferred", "prompt_version": 1, "sources": [{"content_hash": "0934aac87027433e838ffb3bc1ded2cb1b144b47becf502055da9aa7bd336b90", "fetched_at": "2026-08-28T04:09:34.403932+00:00", "kind": "readme", "missing": false, "url": "https://github.com/race2infinity/The-Documentation-Compendium"}], "taxonomy_version": 1}, "health_score": {"inputs": ["days_since_push", "days_since_release", "archived"], "kind": "computed", "method": "health_v1"}, "homepage": {"kind": "observed", "observed_at": "2026-08-28T04:09:34.403932+00:00", "source": "github"}, "language": {"kind": "observed", "observed_at": "2026-08-28T04:09:34.403932+00:00", "source": "github"}, "license": {"kind": "observed", "observed_at": "2026-08-28T04:09:34.403932+00:00", "source": "github"}, "license_family": {"inputs": ["license"], "kind": "computed", "method": "license_family"}, "maturity": {"confidence": null, "enriched_at": "2026-08-29T17:49:14.006465+00:00", "kind": "inferred", "prompt_version": 1, "sources": [{"content_hash": "0934aac87027433e838ffb3bc1ded2cb1b144b47becf502055da9aa7bd336b90", "fetched_at": "2026-08-28T04:09:34.403932+00:00", "kind": "readme", "missing": false, "url": "https://github.com/race2infinity/The-Documentation-Compendium"}], "taxonomy_version": 1}, "member_repos": {"kind": "observed", "observed_at": "2026-08-28T04:09:34.403932+00:00", "source": "github"}, "name": {"kind": "observed", "observed_at": "2026-08-28T04:09:34.403932+00:00", "source": "github"}, "platform": {"confidence": null, "enriched_at": "2026-08-29T17:49:14.006465+00:00", "kind": "inferred", "prompt_version": 1, "sources": [{"content_hash": "0934aac87027433e838ffb3bc1ded2cb1b144b47becf502055da9aa7bd336b90", "fetched_at": "2026-08-28T04:09:34.403932+00:00", "kind": "readme", "missing": false, "url": "https://github.com/race2infinity/The-Documentation-Compendium"}], "taxonomy_version": 1}, "pushed_at": {"kind": "observed", "observed_at": "2026-08-28T04:09:34.403932+00:00", "source": "github"}, "repo": {"kind": "observed", "observed_at": "2026-08-28T04:09:34.403932+00:00", "source": "github"}, "stars": {"kind": "observed", "observed_at": "2026-08-28T04:09:34.403932+00:00", "source": "github"}, "tags": {"confidence": null, "enriched_at": "2026-08-29T17:49:14.006465+00:00", "kind": "inferred", "prompt_version": 1, "sources": [{"content_hash": "0934aac87027433e838ffb3bc1ded2cb1b144b47becf502055da9aa7bd336b90", "fetched_at": "2026-08-28T04:09:34.403932+00:00", "kind": "readme", "missing": false, "url": "https://github.com/race2infinity/The-Documentation-Compendium"}], "taxonomy_version": 1}, "topics": {"kind": "observed", "observed_at": "2026-08-28T04:09:34.403932+00:00", "source": "github"}, "urls": {"kind": "observed", "observed_at": "2026-08-28T04:09:34.403932+00:00", "source": "github"}, "use_cases": {"confidence": null, "enriched_at": "2026-08-29T17:49:14.006465+00:00", "kind": "inferred", "prompt_version": 1, "sources": [{"content_hash": "0934aac87027433e838ffb3bc1ded2cb1b144b47becf502055da9aa7bd336b90", "fetched_at": "2026-08-28T04:09:34.403932+00:00", "kind": "readme", "missing": false, "url": "https://github.com/race2infinity/The-Documentation-Compendium"}], "taxonomy_version": 1}, "what_it_is": {"confidence": null, "enriched_at": "2026-08-29T17:49:14.006465+00:00", "kind": "inferred", "prompt_version": 1, "sources": [{"content_hash": "0934aac87027433e838ffb3bc1ded2cb1b144b47becf502055da9aa7bd336b90", "fetched_at": "2026-08-28T04:09:34.403932+00:00", "kind": "readme", "missing": false, "url": "https://github.com/race2infinity/The-Documentation-Compendium"}], "taxonomy_version": 1}, "when_to_avoid": {"confidence": null, "enriched_at": "2026-08-29T17:49:14.006465+00:00", "kind": "inferred", "prompt_version": 1, "sources": [{"content_hash": "0934aac87027433e838ffb3bc1ded2cb1b144b47becf502055da9aa7bd336b90", "fetched_at": "2026-08-28T04:09:34.403932+00:00", "kind": "readme", "missing": false, "url": "https://github.com/race2infinity/The-Documentation-Compendium"}], "taxonomy_version": 1}, "when_to_choose": {"confidence": null, "enriched_at": "2026-08-29T17:49:14.006465+00:00", "kind": "inferred", "prompt_version": 1, "sources": [{"content_hash": "0934aac87027433e838ffb3bc1ded2cb1b144b47becf502055da9aa7bd336b90", "fetched_at": "2026-08-28T04:09:34.403932+00:00", "kind": "readme", "missing": false, "url": "https://github.com/race2infinity/The-Documentation-Compendium"}], "taxonomy_version": 1}}, "score": {"components": {"activity": 49, "longevity": 100, "rhythm": 35}, "computed_at": "2026-09-03T02:20:16.233290+00:00", "flags": ["no_releases", "no_license"], "formula": "round(0.45*activity + 0.35*rhythm + 0.20*longevity); archived -> min(score, 10)", "inputs": {"age_days": 2648, "days_push": 306, "days_rel": null, "gap_med": null, "n_releases_24m": 0}, "score": 54, "version": 2}, "staleness": {"enrichment_outdated": false, "low_confidence": false, "scrape_days": 9, "stale_scrape": false}}