Project Code Name 项目代码命名规则 - 猫猫得天空♂

/ 0评 / 0

Project Code Name 项目代码命名规则

u24818331502789993294fm253fmtautoapp138fPNG

开发者都会经手很多专案,有些专案目标很确定,而且时程很短,这种专案命名时就不会太难,甚至可以用编号来命名。不过很多时候产品名称是后来才决定的,这时通常会替新专案取个代号 (code name) 来称呼。代号当然是各个组织都有一套偏好的习惯,我自己也有一套代号的命名规则,从务实的角度出发。

规则一:短
专案代号一定要短,为什麽?因为它会出现在你程式的所有地方:

1. 档案的目录名称,你每天都会 cd 一次以上,scripts 也会一直写到。
2. git repository 名称、branch 的名称... 等等
3. 在 Java 裡,所有 class 档都会有 package,因此每个 .java 档都会包含 code name
4. 你可能会用 code name 当做物件的名称,比方说 FooUtils
5. 相关的设定档 (例如 xml) 会一而再再而三的写到

专案代号几乎渗透到所有程式码,你每天都会键入数十次甚至上百次。如果你取代号名称要十个字母,那你是在整自己。不只打字容易出错,而且多花无谓的时间键入。我个人最偏好 4 个字母,不过最长 6 个字母左右也还 ok,再长下去就不太行了。

1. 好的例子 - kaze
2. 坏的例子 - cappuccino

规则二:好唸
这个规则和规则一相关,专案代号除了程式裡会出现,你每天跟你的团队沟通都会用这个词,简单好唸很重要。如果你取了个很饶舌的,或是跟其他的常用字唸起来很像的,这只会增加沟通的成本。虽然只是个单字,但日积月累下来也是很可观的。我个人偏好纯母音结尾的单字,而那些字母间或是结尾有那种不发声的子音的单字我都尽量避免。用头文字去组代号名是 ok 的,但是不要拼出像是 SQL 这种大家对唸法很有争议的单字。

1. 好的例子 - mio
2. 坏的例子 - scsi

规则三:好拼
满足了规则一、二,通常规则三也自动满足了,如果你字母少的话,通常不会拼错字。如果你的单字唸起来单纯,没有夹那种发音很弱的子音,你也不会漏打那些字母。专案代号不见得会是字典裡有的单字,为避免拼错还是选简单的组合吧。

1. 好的例子 - anta
2. 坏的例子 - antarctica

规则四:与产品无关
这个规则有点不直觉。不过如果你手上有专案超过二年的,也许会有点感觉了 - 专案的目标和需求是会变的,这在新创公司更容易出现。专案的方向错了,重新调整再出发是很有可能的,如果你当初取的代号跟原产品有关,忽然切换就会很彆钮。

比方说原本要做一个 email 的 app,当初便取了个叫 postman 的代号,后来你们公司 pivot 了,因为发现原来 email 裡的广告才是好赚的方向。转换过程中,你的程式码尽可能的重用,裡面满满的是 postman 这单字,但其实功能都是些广告相关的了。要重构 postman 这个单字也是不切实际的,只会累死自己而已。

因此我建议选择代号不要跟产品的内容或方向有关,甚至是个无意义的词更好。找不到好词你可以取公司附近的地名,地名跟大部份的事物都没什麽相关性。

1. 好的例子 - nanji (南极)
2. 坏的例子 - postman

小结
专案代号通常是产品名尚未定案前取的。它会用在沟通,用在程式码的各个角落。也许你会结合你的座右铭或是你对专案的期许在代号内,不过,为了开发与沟通的效率,我建议还是简化代号的名称吧。

 

原文链接

返回首页

页面下部广告

发表回复

您的邮箱地址不会被公开。 必填项已用 * 标注

添加底部信息支持HTML語言