none
对微软词库创建工具的使用说明(Readme)写法的一些建议 RRS feed

  • 问题

  • 本人认为,在写一个说明或手册时,应该多考虑不同用户的不同背景,多考虑到可能遇到的情况。减少用户的畏惧心理,减轻软件操作的复杂程度。

     

    注意:此代表个人意见!需要改进的地方,已用红色字体表示。

     

    1 对命令行所举的案例的表示方法。

    如果用户采用默认安装,会安装在Program files文件夹。在所举例中,应考虑命令行不能识别文件路径有空格的问题。所以,所举的例子应该加上半角引号,防止用户误操作。

    应该是:MSDUBuild “c:\mydu\input\myduconfig.ini”

    而不应该是:MSDUBuild c:\mydu\input\myduconfig.ini

     

    2 说明本地化(针对命令行格式)

    这是一个简体中文的说明,面向的是广大中国大陆客户。所以,该用中文的地方应该用中文,而不应该用英文。(说明要本地化)。在Readme文件中的usage表现地特别明显。即使要保留英文格式,也应立即在下面直接对这些表示进行说明。而不应夹杂在后续的小节中分别说明。

     

    Usage: MSDUBuild <Dictionary update configuration file> [<Output lexicon file>]

                       <Dictionary update configuration file>: the configuration ini file

                                         <Output lexicon file> : output lexicon file name (optional)

     

    像上述的描述为何不能写成类似这样的文字呢?

     

    用法:

    MSDUBuild 词库升级配置文件 词库输出文件

     

    说明:

    词库升级配置文件:用于升级配置的ini文件。

    词库输出文件:生成词库的文件名(可选项)

     

    3 在描述词库配置文件格式时,应该加上一个注意事项。

    虽然隐晦地说明了一下WordListFile的使用。但不够醒目,用户可能会理解错误!!!认为可以使用相对路径。(即:只要Word.txtconfigration.ini放在同一文件夹中,就不需要给WordListFile指明绝对路径)

     

    可这样写:

     

    注意:在操作之前,请将用于升级配置的ini文件中的WordList.txtWordList2.txt……,替换为正确的绝对路径文件名。例如:您的WordList.txt位于c:\mydu\input路径下。则相关ini配置文件的表示需进行如下替换

     

    WordListFile=c:\mydu\input\WordList.txt

     

    4 Virtual词库描述过于简单。

    虽然该类型词库是微软不推荐使用的词库类型。但也应稍微说明一下其支持的原则,其安装后在输入法呈现的结果。个人认为:只是用简简单单地说不支持“两字词”过于简单。

     

    5 在“已知问题”一节。有开发用语和英中思维混乱的问题。

    只有Administrator权限的用户才能安装词库升级文件。安装词库升级文件的那个Admin用户缺省就可以使用新的词库,但对于其他用户,无论是Admin用户还是非Admin用户,有两种情况:

     

    上述描述为何不这样写?

     

    只有具有操作系统管理员权限的用户才能安装词库升级文件。安装词库升级文件的那个具有管理员权限的用户默认即可使用新的词库,但对于其他用户,无论是具有管理员权限还是不具有管理员权限,有以下两种情况:

     

    2008年6月2日 7:45
    版主

答案