怎样撰写Features List

发表于 分类于 ， 阅读次数： 本文字数： 986 阅读时长 ≈ 4 分钟

当开发好一款插件的时候，要为插件撰写一个readme.txt文件，这是让用户了解你的插件的最好方式。很多插件都会在readme.txt的第一个section（description）里，附上一个简单明了的features list，以便用户可以快速扫描你插件包含的功能，决定是否选用。那么应该如何撰写features list呢？本文为您介绍。

我不是一个撰写readme.txt的专家，但是我经常需要做这件事情，我自己也很不在行，从来没有仔细研究过这件事情，今天在这里写下的是我第一次研究的笔记。对本文内容的权威性，大家请自己斟酌。

首先来看一看例子：

  • Templates : You can add custom templates for your theme.
  • Media RSS feed : Add the Cooliris Effect to your gallery
  • Role settings : Each gallery has a author
  • AJAX based thumbnail generator : No more server limitation during the batch process
  • Copy/Move : Copy or move images between galleries
  • Sortable Albums : Create your own sets of images
  • Upload or pictures via a zip-file (Not in Safe-mode)
  • Watermark function : You can add a watermark image or text
  • JavaScript Effect : Use any available popular image effect : Shutter, Thickbox, Lightbox or Highslide
  • Multiple CSS Stylesheet : Use a nice shadow effect for your thumbnails with your own CSS file
  • Slideshow : Full integrated flash slideshow
  • TinyMCE : Button integration for easy adding the gallery tags
  • Sidebar Widget : Show a slideshow, random or recent picture at your sidebar
  • Language support : Translated in more than 30 languages
  • Upload tab integration : You have access to all pictures via the upload tab
  • Tag support for images : Append related images to your post, create a image tag-cloud
  • Meta data support : Import EXIF, IPTC or XMP meta data
  • Sort images feature
  • Cool flash addons here : url

这份列表，撰写得有其特色，这是NextGen Gallery的features list。其采用的格式为：“特性名称：简述”。特性名称，一般采用的是名词，可以是具体名词，也可以是动名词，其格式基本上比较统一。

而其简述部分，则比较自由。

第一句，you can do sth. 是一个简单句。以第二人称描述，这跟人的感觉像是一个推销员，在与你说话，隐含了一层意思，“如果你用了本插件”，“你就可以用这款插件做……”。第二句，是一个动宾短语，我们可以猜测其隐含主语，窃以为，仍旧是“你”，“(you are able to) add Cooliris Effect to your gallery (with it)”。看到这里，我们就可以统计一下，这么多features里，使用这两种用法的句子，暗红色为第一种，浅蓝色为第二种。除却这两种，我们还看到其他的例子，用绿色标出的，是我个人认为有一些共同点的例子，第一个是简单句，但是是以第三人称为主语的句子，后面两个，则是分词开头的关于，而我猜测其主语，也为第三人称。

看了看原作者的blog，基本上是英文写成的，而也有少量的德语，我们可以视其为是native speaker。从他撰写的特性列表里，我们可以学习到一些西方人传达信息和接受信息的模式。他们更关心的是，可以用这款插件做什么，他们应该怎么使用这款插件。一款插件的使用方式和其提供的可能性，是他们关心的东西。而插件本身利用的技术，插件本身的性质和特性，不是他们关注的东西。

如果你的插件，有许多的特性，你在描述的时候，应该转换一种表达思路，即这种特性，能够带来一种什么样的使用上的可能性。尽量使用第二人称来描述，“你用它，能够干……”。这是西方人，更能接受的一种方式，也符合他们的表达习惯。

行了，本文就写到这里。其实，我还看了两个插件的features list的，但是基本上雷同，大家可以自己分析。本文主要写给自己看，作为自己学习写作的一些笔记。