﻿<?xml version="1.0" encoding="utf-8" standalone="yes"?><rss version="2.0" xmlns:dc="http://purl.org/dc/elements/1.1/" xmlns:trackback="http://madskills.com/public/xml/rss/module/trackback/" xmlns:wfw="http://wellformedweb.org/CommentAPI/" xmlns:slash="http://purl.org/rss/1.0/modules/slash/"><channel><title>BlogJava-深海有约-随笔分类-开发文档</title><link>http://www.blogjava.net/shaolijun/category/22969.html</link><description /><language>zh-cn</language><lastBuildDate>Sat, 02 Jun 2007 10:46:50 GMT</lastBuildDate><pubDate>Sat, 02 Jun 2007 10:46:50 GMT</pubDate><ttl>60</ttl><item><title>软件技术文档撰写要求 </title><link>http://www.blogjava.net/shaolijun/archive/2007/05/27/120247.html</link><dc:creator>CHUANDAOJUN</dc:creator><author>CHUANDAOJUN</author><pubDate>Sun, 27 May 2007 00:21:00 GMT</pubDate><guid>http://www.blogjava.net/shaolijun/archive/2007/05/27/120247.html</guid><wfw:comment>http://www.blogjava.net/shaolijun/comments/120247.html</wfw:comment><comments>http://www.blogjava.net/shaolijun/archive/2007/05/27/120247.html#Feedback</comments><slash:comments>0</slash:comments><wfw:commentRss>http://www.blogjava.net/shaolijun/comments/commentRss/120247.html</wfw:commentRss><trackback:ping>http://www.blogjava.net/shaolijun/services/trackbacks/120247.html</trackback:ping><description><![CDATA[&nbsp;
<p align=left><span>1 </span><span>针对性</span></p>
<p align=left><span>&nbsp;文档编制以前应分清读者对象，按不同的类型、不同层次的读者，决定怎样适应他们的需要。</span><span>&nbsp;&nbsp;&nbsp;&nbsp;</span></p>
<p align=left><span>&nbsp;&nbsp; ①</span>&nbsp;<span>对于面向管理人员和用户的文档，不应像开发文档</span><span>(</span><span>面向软件开发人员</span><span>)</span><span>那样过多地使用软件的专业术语。</span><span> </span><span>难以避免使用的词汇，应在文档中添加词汇表，进行解释。</span><span>&nbsp;&nbsp;&nbsp;&nbsp;</span></p>
<p align=left><span>&nbsp;&nbsp; ②</span>&nbsp;<span>开发文档使用的专业词汇未被广泛认知的，应添加注释进行说明。</span></p>
<p align=left><span>&nbsp;&nbsp; ③</span>&nbsp;<span>缩写词未被广泛认知的，应在其后跟上完整的拼写。</span><span>&nbsp;&nbsp;&nbsp;&nbsp;<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</span></p>
<p align=left><span>2&nbsp;&nbsp;</span><span>正确性</span>&nbsp;</p>
<p align=left><span>&nbsp;&nbsp; </span><span>①</span>&nbsp;<span>没有错字，漏字。</span></p>
<p align=left><span>&nbsp;&nbsp;&nbsp;</span><span>②</span>&nbsp;<span>文档间引用关系正确。</span>&nbsp;</p>
<p align=left><span>&nbsp;&nbsp;&nbsp;</span><span>③</span>&nbsp;<span>文档细节</span><span>(Title/History)</span><span>正确。</span><span>&nbsp;&nbsp;&nbsp;&nbsp;<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<br>3&nbsp;&nbsp;</span><span>准确性</span></p>
<p align=left><span>&nbsp; &nbsp;</span><span>①</span>&nbsp;<span>意思表达准确清晰</span><span>，</span><span>没有二义性。</span></p>
<p align=left><span>&nbsp;&nbsp;&nbsp;</span><span>②</span>&nbsp;<span>正确使用标点符号</span><span>，</span><span>避免产生歧义。</span><span>&nbsp;&nbsp;&nbsp;&nbsp;<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<br>4&nbsp;&nbsp;</span><span>完整性</span>&nbsp;</p>
<p align=left><span>&nbsp;&nbsp; </span><span>①</span>&nbsp;<span>意思表达完整，能找到主语、谓语、宾语，没有省略主语，特别是谓语。</span></p>
<p align=left><span>&nbsp;&nbsp;&nbsp;</span><span>②</span>&nbsp;<span>一句话中不能出现几个动词一个宾语的现象。</span></p>
<p align=left><span>&nbsp;&nbsp;&nbsp;</span><span>③</span>&nbsp;<span>不遗漏要求和必需的信息。</span><span>&nbsp;&nbsp;&nbsp;&nbsp;<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<br>5&nbsp;&nbsp;</span><span>简洁性</span>&nbsp;</p>
<p align=left><span>&nbsp;&nbsp; </span><span>①</span>&nbsp;<span>尽量不要采用较长的句子来描述，无法避免时，应注意使用正确的标点符号。</span></p>
<p align=left><span>&nbsp;&nbsp;&nbsp;</span><span>②</span>&nbsp;<span>简洁明了，不累赘冗余，每个意思只在文档中表达一次。</span><span>&nbsp;&nbsp;</span></p>
<p align=left><span>&nbsp;&nbsp;&nbsp;</span><span>③</span>&nbsp;<span>每个陈述语句，只表达一个意思。</span><span>&nbsp;&nbsp;&nbsp;&nbsp;</span></p>
<p align=left><span>&nbsp;&nbsp;&nbsp;</span><span>④</span>&nbsp;<span>力求简明，如有可能，配以适当的图表，以增强其清晰性。</span><span>&nbsp;&nbsp;&nbsp;&nbsp;<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<br>6&nbsp;&nbsp;</span><span>统一性</span>&nbsp;</p>
<p align=left><span>&nbsp;&nbsp; </span><span>①</span>&nbsp;<span>统一采用专业术语和项目规定的术语集。</span></p>
<p align=left><span>&nbsp;&nbsp;&nbsp;</span><span>②</span>&nbsp;<span>同一个意思和名称，前后描述的用语要一致。</span>&nbsp;</p>
<p align=left><span>&nbsp;&nbsp;&nbsp;</span><span>③</span>&nbsp;<span>文档前后使用的字体要统一。</span><span>&nbsp;&nbsp;&nbsp;&nbsp;</span></p>
<p align=left><span>&nbsp;&nbsp;&nbsp;</span><span>④</span>&nbsp;<span>同一课题若干文档内容应该协调一致，没有矛盾。</span><span>&nbsp;&nbsp;&nbsp;&nbsp;<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<br>7&nbsp;&nbsp;</span><span>易读性</span>&nbsp;</p>
<p align=left><span>&nbsp;&nbsp; </span><span>①</span>&nbsp;<span>文字描述要通俗易懂。</span>&nbsp;</p>
<p align=left><span>&nbsp;&nbsp;&nbsp;</span><span>②</span>&nbsp;<span>前后文关联词使用恰当。</span><span>&nbsp;&nbsp;</span></p>
<p align=left><span>&nbsp;&nbsp;&nbsp;</span><span>③</span>&nbsp;<span>文档变更内容用其他颜色与上个版本区别开来。</span>&nbsp;</p>
<p align=left><span>&nbsp;&nbsp;&nbsp;</span><span>④</span>&nbsp;<span>测试步骤要采用列表的方式，用</span><span>1)</span><span>、</span><span>2)</span><span>、</span><span>3)&#8230;</span><span>等数字序号标注。</span>&nbsp;</p>
<p>&nbsp;</p>
<img src ="http://www.blogjava.net/shaolijun/aggbug/120247.html" width = "1" height = "1" /><br><br><div align=right><a style="text-decoration:none;" href="http://www.blogjava.net/shaolijun/" target="_blank">CHUANDAOJUN</a> 2007-05-27 08:21 <a href="http://www.blogjava.net/shaolijun/archive/2007/05/27/120247.html#Feedback" target="_blank" style="text-decoration:none;">发表评论</a></div>]]></description></item></channel></rss>