---
id: 3458
title: "Read Me First: An Intro to Internal READMEs"
source_domain: hackerone.com
source_url: "https://www.hackerone.com/blog/read-me-first-intro-internal-readmes"
published_at: "2018-09-05T08:45:24Z"
tags: ["open-source", "documentation", "developer-experience", "engineering-culture", "readme"]
phying_url: "https://phying.com/item/3458"
lang: en
---

# Read Me First: An Intro to Internal READMEs

## Summary

An argument for internal READMEs: mission-critical company repos often have empty docs while open source projects thrive on great ones; a useful README helps teams ship cleaner code faster.

## Intelligence Metadata

- **Sources:** hackerone.com
- **Published:** 2018-09-05T08:45:24Z
- **Original:** https://www.hackerone.com/blog/read-me-first-intro-internal-readmes
- **Phying News:** https://phying.com/item/3458