We had a discussion on the dev list nearly a year ago about getting better at documenting designs in Drill [1]. We were all mostly in agreement that we should write better design documents and I just wanted to revisit the topic.
Some of the more complex features being worked on recently, DRILL-4800 and DRILL-4820 to name a couple, have used a common format for the design, and it has proven to be quite useful. I've put a basic template at [2]. Do folks have any comments about the template? I would like to encourage folks working on complex features to use this as a guideline to writing design proposals and for reviewers to use while reviewing. I don't think every JIRA needs a design document (sometimes the JIRA is enough), and I would leave it open for the contributor to use whatever technology they feel comfortable with (provided reviewers can comment easily). What do people think? If everyone agrees I would like to provide a link to this document from the Contribute to Drill page. Parth [1] http://mail-archives.apache.org/mod_mbox/drill-dev/201510.mbox/%3CCAAOiHjFDOZE%2Br2zmn%2BYWF%3DbKc4JAocVKGcvaCpfTj0gXdfxLUw%40mail.gmail.com%3E [2] https://docs.google.com/document/d/1PnBiOMV5mYBi5N6fLci-bRTva1gieCuxwlSYH9crMhU/edit?usp=sharing
