RichardLitt / knowledge

💡 document everything
MIT License
248 stars 20 forks source link

WIP Manifesto Driven Development #17

Closed RichardLitt closed 4 years ago

hackergrrl commented 7 years ago

Sounds interesting Richard! Do you have an example of a project developed this way?

RichardLitt commented 7 years ago

Not yet! I'm hoping to start with something later today or this weekend, though.

RichardLitt commented 7 years ago

@noffle I've written up an example, in the README for Katahdin. What do you think about it? Does it make sense what I meant now?

hackergrrl commented 6 years ago

@RichardLitt

  1. Cool name :+1:
  2. I really like having a write-up that explains both a) the problem the module solves, and b) how it works. I wish more modules included these kinds of details. "Why does this exist!?"
  3. A usage example would really drive the understanding home for me. I understand this is WIP though, so this might already be forthcoming.
  4. I dig the project itself: a simple CLI app that I could run in my project dir and get a list of newline-delimited keywords to stdout would be super cool! Props if it has works offline, maybe /w degraded quality.

Overall, it sounds like your development is being driven by your ability to first write a clear, legible, understandable explanation of what your module is and how it works. This seems somewhat consistent with the definition of manifesto, which is a published verbal declaration of the intentions, motives, or views of the issuer, be it an individual, group, political party or government. It's not really a document of your personal views, but the intention of a specific piece of software. So maybe that's an intention mismatch, or maybe it'll still be understandable. On the whole, I think there is huge benefit to proving, even if just to yourself, that you can write a clear explanation of what you're doing, why, and how it works, prior to putting code to paper. :+1:

RichardLitt commented 6 years ago
  1. Thanks. 2. Thanks. 3. Yes. WIP! 4. Word.

I think it is setting the intentions which is important. Somewhat similar to Readme-Driven Development, but more about setting the why first.

RichardLitt commented 4 years ago

Closing as stale. Interesting stuff here, but priorities.