芯片手册需要标注参考文献。参考文献告诉我们信息的来源。别人可以查找这些资料。手册内容更可信。工程师设计电路需要准确数据。错误数据导致产品问题。标注参考文献是专业做法。
参考文献有许多种类。有些是书籍。书籍提供系统知识。书籍作者通常是专家。书籍内容经过仔细检查。有些是学术论文。论文讲新的研究成果。论文内容很专门。有些是技术报告。公司发布技术报告。报告描述芯片特性。有些是公开标准文档。行业制定统一标准。标准保证芯片兼容性。有些是网站文章。网站更新很快。网站文章提供最新消息。这些都可以作为参考文献。
标注参考文献有固定格式。格式让人容易看懂。不同地方格式不同。我们常用几种格式。第一种是顺序编码制。文中出现引用就标数字。数字放在方括号里。例如“芯片工作电压为3.3V[1]”。文末列出参考文献列表。列表按数字顺序排列。第二种是作者年份制。文中标出作者和发表年份。例如“Smith(2020)指出该结构功耗更低”。文末参考文献按作者名字排序。格式必须统一。不能混合使用两种格式。统一格式看起来整齐。查找资料也方便。
芯片手册引用其他芯片资料。例如新型号引用旧型号数据。手册需要标注旧型号手册编号。工程师可以对比两个型号。引用公司内部文档要小心。内部文档可能保密。公开手册不能列出保密内容。可以改为引用公开数据。或者获得许可后引用。
图表数据也要标注来源。图表从其他文章复制需要permission。得到许可能够使用。图表下方写上来源信息。例如“图1:功耗对比图(来源:XX论文)”。自己制作的图表不用标注。测试数据出自本实验室要说明。说明测试条件和方法。别人可以重复测试验证。
参考文献信息必须完整。书籍需要作者姓名。书籍需要书名。书籍需要出版社名字。书籍需要出版年份。书籍需要页码引用。论文需要作者姓名。论文需要文章标题。论文需要期刊或会议名称。论文需要发表年份。论文需要卷号和期号。论文需要页码。技术报告需要报告编号。技术报告需要发布机构。技术报告需要发布日期。网站需要网页标题。网站需要网址。网站需要访问日期。信息完整别人才找得到。缺少信息等于没有引用。
查找参考文献是编写手册的步骤。先确定手册需要哪些内容。内容涉及哪些技术领域。去图书馆查找相关书籍。在学术数据库搜索论文。使用关键词搜索。关键词可以是芯片类型。关键词可以是技术名称。查看论文后面参考文献列表。能找到更多相关文章。去芯片公司网站下载资料。公司网站有产品文档。参加技术会议获取最新信息。会议资料有时比出版快。收集足够资料再开始编写。
编写时注意引用位置。介绍基本概念时引用教科书。描述技术背景时引用综述文章。列出性能参数时引用测试报告。对比不同方案时引用研究论文。提出新方法时引用自己的专利。每个重要陈述最好有依据。没有依据的陈述需要特别说明。例如“根据本公司测试结果”。不要假装别人的观点是自己的。这是抄袭行为。抄袭是不对的。
参考文献列表放在手册末尾。列表标题写“参考文献”。英文手册写“References”。每条参考文献单独一段。首行可以缩进也可以不缩进。但全文要一致。按文中出现顺序编号。或者按作者字母排序。格式示例:
书籍格式:[序号]作者.书名.出版社,出版年.
论文格式:[序号]作者.文章标题.期刊名,年份,卷号(期号):起止页码.
报告格式:[序号]作者.报告标题.机构名称,报告编号,年份.
标准格式:[序号]标准号标准名称.发布机构,年份.
专利格式:[序号]专利申请人.专利名称.专利号,公布日期.
电子文献:[序号]作者.文章标题.网址,访问日期.
注意标点符号。中文手册用中文标点。英文手册用英文标点。作者名字写法一致。中文名字写全名。英文名字写首字母加姓。不要有时写全名有时写缩写。
核对参考文献很重要。写完手册后检查每个引用。文中标号与列表编号对应。列表信息与原始资料一致。特别是网址容易变动。网址可能失效。尽量引用稳定来源。学术期刊比个人博客可靠。公司官网比论坛帖子可靠。重要数据最好有多个来源。多个来源说法一致更可信。
团队编写手册需要统一规则。制定内部参考文献格式指南。所有编写人员遵守同一指南。一个人负责最终检查。检查格式是否正确。检查内容是否完整。确保整本手册风格统一。
标注参考文献是细致工作。需要耐心和认真。开始可能觉得麻烦。习惯后变成自然步骤。好的参考文献让手册质量提高。工程师信任这样的手册。产品设计减少错误。公司形象也更好。
芯片技术发展很快。新论文不断发表。手册更新时参考文献也要更新。过时的参考文献没有帮助。甚至可能误导读者。定期查看最新研究。替换旧参考文献。保持手册内容新鲜。
简单手册可能不需要参考文献。例如只有一页的简介。但详细设计手册必须包含。这是对读者的负责。也是对自己工作的尊重。正确标注参考文献体现专业水平。工程师之间沟通更顺畅。技术知识积累更扎实。行业技术进步更快。
这些就是芯片手册标注参考文献的方法。道理不难。关键是要去做。认真对待每个细节。手册就会越写越好。