java 技术实验规范文档（初稿）

Posted 2021-05-07

package org.hujian.common;

/**
 *
 *             技术实验流程及文档规范（Specification for technical experiments documents and experiments flow）
 *
 *    第一章、总则
 *
 *      本规范用于技术实验流程及文档规范，包括实验流程和实验文档两部分，实验流程用于规范一个技术实验的实施流程，实验文档
 *   用于记录、分析、总结实验，需要规范实验文档，实验文档是实验的重要成果组成，需要详细的记录总结下来，便于回溯实验。
 *      实验流程用于规范实验流程，本文接下来的部分将会详细描述每一个实验流程，包括实验选题、资料收集、实验目的确认、实验
 *   过程（实验步骤）、实验结果、实验分析及实验结论部分，实验收获以及实验文档也属于实验流程，但是实验收获与实验文档与文档
 *   记录的相关性更强，归属于实验文档部分；实验文档分为实验收获及实验文档两个内容，实验文档需要将实验的全流程及实验收获记录
 *   下来，并且按照"实验文档"章节中描述的规范来记录实验文档。
 *      每个实验都将有一个实验编号，便于索引具体的实验，实验编号的组成包括下面几部分。
 *
 *      | 实验时间 | 实验课题类型 | 实验耗时 | 实验评估分 | 实验状态 | 预留|
 *
 *      实验编号是一个唯一标识一个实验的id，包括实验时间、实验课题类型、实验耗时、实验评估分以及一个预留字段组成，这些组成的内容
 *   均要求为数字类型，在生成实验编号的时候中间使用"_"连接组成，下面是每一个组成部分的详细描述。
 *      实验时间：描述实验开始的时间，应该是一个unix时间戳
 *      实验课题类型：课题类型由两部分组成
 *              | 技术大类 | 实验类型 |
 *      其中，技术大类取值如下：
 *      |--------------------|---------|
 *      | Tech Type          |  value  |
 *      |--------------------|---------|
 *      | Programing Language| 001     |  编程语言
 *      |--------------------|---------|
 *      | Operating System   | 002     |  操作系统
 *      |--------------------|---------|
 *      |     NetWork        | 003     |  网络技术
 *      |--------------------|---------|
 *      |    DataBase        | 004     |  数据库（包括缓存）
 *      |--------------------|---------|
 *      | compile tech       | 005     |  编译技术
 *      |--------------------|---------|
 *      |   protocol         | 006     |  协议（比如http）
 *      |--------------------|---------|
 *      |   codec/decode     | 007     |  编码，序列化等
 *      |--------------------|---------|
 *      |   other            | 100     |  其他（比如分布式技术等）
 *      |--------------------|---------|
 *      实验类型规范如下：
 *      |--------------------|---------|
 *      | experiment type    |  value  |
 *      |--------------------|---------|
 *      |   explore          |  01     |  为了探索某一个特性
 *      |--------------------|---------|
 *      |   confirm          |  02     |  为了证实某一个课题
 *      |--------------------|---------|
 *      |   study            |  03     |  纯粹学习时需要
 *      |--------------------|---------|
 *      |   other            |  10     |  其他一切类型
 *      |--------------------|---------|
 *
 *      接下来的实验耗时部分应该是从实验时间到事件结束时间的差值，单位应该为毫秒。
 *      实验评估分是一个0-100的数字，评分标准参考下面：
 *      |-------------------------------------------|---------------------|
 *      |               requires                    |     score value     |
 *      |-------------------------------------------|---------------------|
 *      |    experiment completed                   |     60              |   实验基本完成
 *      |-------------------------------------------|---------------------|
 *      |    experiments success                    |     70              |   实验步骤全部完成
 *      |-------------------------------------------|---------------------|
 *      |    explore/confirm something done         |     80              |   实验全部完成，并且得到合理的实验结果
 *      |-------------------------------------------|---------------------|
 *      |    flow/result/time ok                    |     90              |   实验流程规范，获得结论并且耗时合理
 *      |-------------------------------------------|---------------------|
 *      |    Sufficient information                 |     100             |   资料充足，论证充分，实验成功
 *      |-------------------------------------------|---------------------|
 *
 *      实验状态是一个非常重要的信息，用于标记该实验目前所处的状态，包括下面几种可选的状态：
 *      |---------------------|------------|
 *      |   status            |  value     |
 *      |---------------------|------------|
 *      |   done              |  00        | 实验完成
 *      |---------------------|------------|
 *      |   delay             |  01        | 实验被某些原因delay
 *      |---------------------|------------|
 *      |   half              |  02        | 实验没有做完，需要后续补充完成
 *      |---------------------|------------|
 *      |   abort             |  03        | 抛弃实验，后续不会再进行该未完成的实验，一般发现实验目的错了的时候使用
 *      |---------------------|------------|
 *      |   unknown           |  10        | 不要出现这种情况
 *      |---------------------|------------|
 *
 *      预留字段用于追加一些额外的实验信息，默认为10个0（"0000000000"）
 *
 *      一个完整的实验编号例子如下：
 *      
 *      1541159773561_00101_1000_90_00_0000000000
 *
 *
 *    第二章、实验选题
 *
 *       实验选题即实验的课题，需要挑选一个切实可行的实验课题，不可大而广，范围应该小，并且明确，在总则中详细描述了实验类型，应该
 *    严格按照实验类型来定义实验选题，实验选题应该具备良好的可读性，避免模棱两可，比如一个可行的实验选题为 "证实JVM 优先在Eden区域分配内存" 
 *    而类似于 "java JVM GC的使用实验"属于一个范围较广及不好实现的选题，并且选题没有明确的目标。
 *      实验选题部分应该说明为什么会选择这个课题，从哪里获取到实验源头，以及定义这个实验标题的原因介绍等。该部分虽然较为简单，但是是
 *    整个实验的开端，一个好的实验选题可以让实验进行的更为顺利，并且在实验过程中能获取到更多的知识。  
 *      应该在文档内记录好实验选题的定稿时间。
 *
 *    第三章、实验资料收集
 *
 *       在实验选题确定之后，就需要将实验所需要的知识、资料罗列出来，按照一定的排版说明每一个资料的来历及为收集原因，资料可以包括书籍、链接等
 *    内容，甚至可以包括概念及专有名词等特殊的内容。   
 *
 *    第三章、实验目的
 *
 *       实验目的是非常重要的一项，在选好实验课题之后，应该明确实验目的，合理的来说，从实验选题上就可以感受到实验目的，强烈建议使用"证实"、"探索"
 *    等词作为实验选题，在实验目的这一环应该定好实验需要达到的目的，需要罗列具体的指标，比如需要完成测试XXX，看到什么现象等具体的可以感受到实验结果
 *    的内容。
 *
 *    第四章、实验过程
 *
 *       实验过程不包括前面的三章内容，仅包括实验实际操作过程，建议按照时间轴记录实验过程，包括时间、实验步骤，实验现象等内容，需要将实验的每一
 *    个步骤记录下来，并且说明操作该步骤的动机及原因，以及是否符合期望等内容，该部分内容可扩展性较大，可以按照每一个实验选题的不同合理安排即可。
 *
 *
 *    第五章、实验结果
 *
 *       实验结果应该简洁明了，总结整个实验过程中可直接得出的结论，当然实验结果和实验结论章节的规范还是有区别的，实验结果应该是不需要分析即可得到
 *    的结论，而实验结论应该包含实验结果章节的内容及实验分析章节的内容，并且是高度概括的内容。
 *
 *    第六章、实验分析
 *
 *       对实验中出现的现象，不同操作得到的不同实验现象的合理描述及分析，运用实验资料中的知识进行分析论证，得出隐藏在本次实验中的结论。
 *
 *    第七章、实验结论
 *
 *       该部分内容是对整个实验的总结，包括实验结果和实验分析的归纳，实验结论应该简洁明了，读完即可得到实验目的，这一章节需要和实验目的章节
 *    联合起来，需要说明该实验是否达到了实验目的，如果达到了，应该描述出实验结论，如果无法完成实验目的，应该将无法完成的原因描述出来；实验
 *    结论章节应该是整个实验文档中最为重要的一部分内容，因为实验结论应该能让人很快明白实验目的及实验结论，并且包含实验原理等内容。
 *
 *    第八章、实验收获
 *
 *      包括对实验方法、只是储备等方面的突破。该章节可选。
 *  
 *
 *    第九章、实验文档
 *
 *      实验文档是对整个实验的记录和整理，需要将上述描述的所有部分记录下来，文档格式应该按照上述章节描述的顺序整理，实验文档标题（title）中
 *    应该包括实验编号，实验标题的内容包括下面几部分内容：
 *    
 *    |  实验标题 | 实验编号 |
 *    中间使用下划线"_"来隔离，比如下面是一个合法的实验文档标题：
 *    "探索Http粘包问题及解决方案_1541159773561_00101_1000_90_00_0000000000"
 *
 *
 *
 *
 *
 *
 *
 *
 *  Written by Hu Jian
 */


/**
 * Created on 2018/11/2 18:55.
 */
public class TechnicalExperimentDoc {}