Is there any Technical Design Document template?

[Vivek Ganesan <vi...@vivekganesan.com>]

Hi,

I am currently working on a solution for HDFS-2933 
<https://issues.apache.org/jira/browse/HDFS-2933>.

Before actual coding, I would like to put my thoughts/ideas in a document.

Is there any technical design document template which we use in 
Hadoop(HDFS) development? Or, can I use my own format for the technical 
design.

If there is any such template, where can I find a copy of the template?

Thanks  in advance.

Regards,
Vivek Ganesan

Re: Is there any Technical Design Document template?

[Jun Ping Du <jd...@vmware.com>]

Hi Vivek,
   I don't think there are any "standard" design doc format when you draft your ideas for jira. You can choose to attach a pdf doc like MAPREDUCE-279 or put your thought directly on JIRA in MD format like YARN-117. Any way you can use but just to make sure it is clear and easily understood. 

Thanks,

Junping

----- Original Message -----
From: "Vivek Ganesan" <vi...@vivekganesan.com>
To: hdfs-dev@hadoop.apache.org
Sent: Friday, August 16, 2013 9:10:06 PM
Subject: Is there any Technical Design Document template?

Hi,

I am currently working on a solution for HDFS-2933 
<https://issues.apache.org/jira/browse/HDFS-2933>.

Before actual coding, I would like to put my thoughts/ideas in a document.

Is there any technical design document template which we use in 
Hadoop(HDFS) development? Or, can I use my own format for the technical 
design.

If there is any such template, where can I find a copy of the template?

Thanks  in advance.

Regards,
Vivek Ganesan