• procrastitron@lemmy.world
    link
    fedilink
    English
    arrow-up
    2
    ·
    13 days ago

    The README should be the first thing you write, not the last.

    If you follow a “docs driven development” approach then you use the README (and other docs) to guide the design of the project, and wind up with something that is categorically more usable as a result.

    That makes the README both the most important step and the earliest because it lays the foundation for the project.

    That also means you can’t use AI to write it because it’s starting from a clean slate.

    You also shouldn’t use it because that’s the part that is the most important thing to carefully think through.