正在加载...
 

TigerWoods

--世上自有公道,付出总有回报

编写优秀技术文档的技巧(转载)  

售前、售后技术人员仔细看看,应该有所提高的:

 

编写优秀技术文档的技巧(转载)
作者:ZDNet BUILDER.COM

 

拥有准确的技术文档不仅对于公司是非常有益处的,而且也能够让客户从中受益。由于产品如何使用在某种程度上是要依赖技术文档来进行说明的,因此技术文档必须十分的准确可靠。使用不准确的和已经过时的技术文档对于公司的发展也会产生一定的阻碍,同样的,它也会对公司的客户们产生消极的影响。一旦客户发现在他们使用产品的时候遇到了问题,却不能通过求助于伴随产品的技术文档的手段进行解决的时候,客户们就会对这种产品产生怀疑乃至于失去信心,那么,公司的信誉和利益自然而然的就会受到损害。这就是不准确的和过时的技术文档给我们带来的危害。


缺乏准确性以及内容晦涩难懂都会让开发新手以及其他的一些技术工作者们对这些技术文档敬而远之,从而不利于他们的学习和掌握。在本篇文章中,我们要讨论的就是如何在你的开发小组中编写出准确而且易于掌握的技术文档。

技巧一:制定出一个技术评价核对表

许多的程序开发设计者以及管理者都缺乏从技术上评价一个文档的经验。这里有一些方法可以提高这些技术文档的准确性:

把注意力集中于技术事实上,这样能够核实这些技术是作为技术文档而被编写出来的。技术评论的工作并不等同于一般的编辑工作。
一定要从技术上核实,在技术文档里编写的程序与步骤的准确性。
一定要从技术上核实,在技术文档中使用的图片捕捉的准确性。

技巧二:一定要在技术文档编写的过程中明确责任

技术文档编写不好的一个原因常常是由于对它不够重视。这是由于在编写技术文档的时候,没有十分的明确各种责任。因此,一定要在技术文档编写的过程中明确责任,这些方法包括:

在技术文档中加入作者以及相关人员的姓名。一些公司可能有规定,禁止出现员工的姓名,但是在技术文档中包含作者以及相关人士姓名的做法能够促进这些内部员工之间的交流。对于外部的文档使用者,比如为商业现货软件编写的用户指南,可以加入作者以及相关人员的姓名,用以明确和承认他们对开发所做的工作和贡献。
把文档的技术评论作为提供给开发设计人员的年度评论的一部分。
在项目计划中指派专人负责技术评论的工作。

技巧三:增加技术文档编写者的准确性

由于技术文档编写者在许多公司内都是非常主观的一个职位,并且编写技术文档也是他们最主要的职责,因此做这些工作的人都必须与他们所编写的技术文档的准确性有着直接的利害关系。

管理人员应该为技术文档编写者设置适当的技术准确级别,并要求他们把准确性保持在这一范围之内。由于一些技术文档编写者对于提升自己对于技术的理解总是不太积极主动,因此,增加他们的责任让他们面对更多的压力对项目里的每一个人来说都是有好处的。如果一个技术文档编写者无法达到更高的标准,那么你就需要重新审视一下你的技术文档编写者是否能够满足你们的团队的战略要求,是否能够满足客户们的需要呢?

为了帮助技术文档编写者,你需要让他们对于具体的技术有着更深层次的认识,因此,作为管理者,你应该:

让技术文档编写者多参加有关产品设计与开发的小组会议。
让技术文档编写者参与到技术要求、功能规范以及设计方案的开发工作中去。
把技术文档编写者包括进开发小组的邮件列表中去。
这技术文档编写的周期,把产品在公司内部进行发布。技术文档编写者很容易变得非常封闭,但是如果把产品在内部首先发布一下,那么就能够给开发人员以及项目管理人员提供一种新的途径来了解以前可能并不容易了解的情况。
鼓励技术文档编写者更多的了解有关产品背后所包含的各种技术。举个例子来说,如果你开发基于Java语言的应用软件,那么,就应该鼓励技术文档编写者多多了解Java编程语言,并且尽量让他们能够流畅的掌握这门编程语言。

技巧四:设置任务的优先次序
通常的情况下,主要的开发设计人员脑海中包含着有关整个项目的信息,而且,有时候还会同时考虑许多其它的项目。即使他或者她的日程安排已经非常的紧张,但是,他们脑海中的产品信息对于确保技术文档编写的准确性来说是非常重要的。

当前的形势让我们不得不以更少的资源完成更多的任务,而作为开发设计人员,由于他们工作的特殊性,这些人总是处于紧张而繁忙的状态下。下面是一些技巧,可以帮助你从这些忙碌的开发设计人员哪里获得你所需要的信息,并且保证能让他们的知识给技术文档的编写带来好处:

不要让他们从头至尾的审阅技术文档。
和技术文档的编写者一起确定哪些部分必须让开发设计人员进行审阅。
与他们一起利用大段的完整时间来审阅技术文档。
如果技术文档的审阅者时间表安排得很紧,那么就给他提供一个具体的列表,在其中明确哪些部分你需要他进行审阅的。并且保证让小组内的其他成员完成剩余部分的审阅工作。技术文档中与审阅者专业技术领域直接相关的部分绝对是需要他进行仔细审阅的。
更好的完成审阅工作
充分有效的完成技术文档的审阅工作不仅会让外部的用户,也会让内部的用户从中受益。但是,经常会有技术人员认为做这样的工作是没有多大意义的,那么,作为管理者就面对着这样一种挑战,就是要在整个的审阅过程中设置好优先次序从而保证为开发工作所做出的努力获得成功。

 

标签:管理,资料 | 浏览数(2337) | 评论数(0) | 2006-08-18
成为你想成为的人(转载)  

成为你想成为的人(转载)

摘自www.lmi-china.com

以下12个方法是各行各业的企业领导人总结出来的,看看我们具备多少条?还有哪些不足和差距?

1 书面的、明确的目标计划:

目标提供了方向,可以培养自信、提升自我形象、节省时间、助你关注、减少冲突、改进决策的质量、降低压力。目标必须写下来成为计划书,只有书面的计划才能使你的目标明确、条理清晰并帮助你澄清思路,唯此方能引发你正确的行动。

2 “自我启动”者:

成就者都有主动性和“现在就做”的态度。

3 做出并坚守承诺:

这不仅能使你自己对自己感到满意,也会让别人对你感到满意。要想被信任,你首先要成为一个值得信任的人。当你持续地做出承诺,坚守承诺,人们会信任你,尊重你的想法并采取行动。

4 承担个人责任:

当你遇到挑战时,指责他人、抱怨环境、找出困难最容易做到。而当你发展出这样的态度:“事情就是这样,一定与我有关”,你的环境就会改变,困难就能转化成为机会,别人也会支持你。

5 突破舒适区:

人人都有各自的舒适范围,如果你需要享受更有成就的人生,就需要更多的投入,这就需要你突破自身的舒适区,去伸展、去成长。你可能在这个过程的开始阶段感到很不舒服、难以适应,但坚持下去成为习惯之后就变成了新的舒适区,将带给你高额的回报。

6 克服消极制约:

不管你的父母、教师以及其他人如何支持你,你或多或少地都曾经接受了一些负面的制约,但你可以通过积极的自我肯定来克服这些负面的制约,培养积极的态度。

7 相信自己:

专注于你的优势而不是弱势。写下你已经完成的目标,写下别人对你积极的肯定。当你相信你自己的时候,别人就会相信你了。

8 用更少的时间完成更多的工作:

每个人的时间都很有限,学习使用时间管理技术,让你在更有限的时间里有更多的成就。

9 有意识释放潜能:

开启电灯并不能发电,仅仅是释放了电能,因为电能已经存在。你的潜力也一样,通过具像化释放你的潜能,你就能“看到”你能够成就什么,采取必要的行动来建设性地使用你的潜能。

10 保护好你的态度:

无论你的态度多么好,如果让环境影响了你的态度,就不能取得成就。要与那些支持你及你的目标的人交往,阅读、聆听积极的资讯,使用积极的自我对话。避免能搅乱你态度的外部环境。

11 提高自我价值感:

如同通过存钱和投资能提高你的财务净现值一样,你也可以通过欣赏你自己、了解自己的优势和成就而提高你的自我价值,专注于你“要”达成什么,而不要专注于你“不要”什么。你取得的成就会影响你的自我形象。

12 学会如何控制:

人们能够控制自己的生活,可控制的领域远比你想像的要多,要学会控制自己,这包括了控制自己的时间、精力的投入、态度和想法、说什么和如何说、如何看问题、如何行动、该效仿谁、与谁共度休闲时间、承诺、在某事上花时间的原因、担忧和恐惧、如何回应困难、如何看待别人以及如何看待人与人之间的关系等等。

阅读全文...
标签:管理 | 浏览数(1734) | 评论数(0) | 2006-07-30
管理故事:为什么我们总是比别人钱少?(转载)  

一个经典的管理小寓言,蛮有意思的,分享一下。

 

为什么我们总是比别人钱少?

——经典管理寓言


一条猎狗将兔子赶出了窝,一直追赶他,追了很久仍没有捉到。
牧羊看到此种情景,讥笑猎狗说"你们两个之间小的反而跑得快得多。"
猎狗回答说:"你不知道我们两个的跑是完全不同的!我仅仅为了一顿饭而跑,他却是为了性命而跑呀!"

[separator]


............................目标.... ............................


这话被猎人听到了,猎人想:猎狗说的对啊,那我要想得到更多的猎物,得想个好法子.
于是,猎人又买来几条猎狗,凡是能够在打猎中捉到兔子的,就可以得到几根骨头,捉不到的就没有饭吃.这一招果然有用,猎狗们纷纷去努力追兔子,因为谁都不愿意看着别人有骨头吃,自已没的吃.就这样过了一段时间,问题又出现了.大兔子非常难捉到,小兔子好捉.但捉到大兔子得到的奖赏和捉到小兔子得到的骨头差不多,猎狗们善于观察,发现了这个窍门,专门去捉小兔子.慢慢的,大家都发现了这个窍门.猎人对猎狗说:最近你们捉的兔子越来越小了,为什么?猎狗们说:反正没有什么大的区别,为什么费那么大的劲去捉那些大的呢?
[幽

默家电子杂志] http://www.efunster.com
.................................动力.........................


猎人经过思考后,决定不将分得骨头的数量与是否捉到兔子挂钩,而是采用每过一段时间,就统计一次猎狗捉到兔子的总重量.按照重量来评价猎狗,决定一段时间内的待遇.
于是猎狗们捉到兔子的数量和重量都增加了.猎人很开心.
但是过了一段时间,猎人发现,猎狗们捉兔子的数量又少了,而且越有经验的猎狗,捉兔子的数量下降的就越利害.于是猎人又去问猎狗.
猎狗说"我们把最好的时间都奉献给了您,主人,但是我们随着时间的推移会老,当我们捉不到兔子的时候,您还会给我们骨头吃吗?"


.............................长期的骨头........................


猎人做了论功行赏的决定.分析与汇总了所有猎狗捉到兔子的数量与重量,规定如果捉到的兔子超过了一定的数量后,即使捉不到兔子,每顿饭也可以得到一定数量的骨头. 猎狗们都很高兴,大家都努力去达到猎人规定的数量.一段时间过后,终于有一些猎狗达到了猎人规定的数量.这时,其中有一只猎狗说:我们这么努力,只得到几根骨头,而我们捉的猎物远远超过了这几根骨头.我们为什么不能给自己捉兔子呢?"于是,有些猎狗离开了猎人,自己捉兔子去了.


..............................骨头与肉兼而有之...........


猎人意识到猎狗正在流失,并且那些流失的猎狗像野狗一般和自己的猎狗抢兔子。
情况变得越来越糟,猎人不得已引诱了一条野狗,问他到底野狗比猎狗强在那里。
野狗说:“猎狗吃的是骨头,吐出来的是肉啊!”,接着又道:“也不是所有的野狗都顿顿有肉吃,大部分最后骨头都没的舔!不然也不至于被你诱惑。” 于是猎人进行了改革,使得每条猎狗除基本骨头外,可获得其所猎兔肉总量的n%,而且随着服务时间加长,贡献变大,该比例还可递增,并有权分享猎人总兔肉的m%。就这样,猎狗们与猎人一起努力,将野狗们逼得叫苦连天,纷纷强烈要求重归猎狗队伍。


故事还在继续................

--------------------只有永远的利益,没有永远的朋友--------------

日子一天一天地过去,冬天到了,兔子越来越少,猎人们的收成也一天不如一天。而那些服务时间长的老猎狗们老得不能捉到兔子,但仍然在无忧无虑地享受着那些他们自以为是应得的大份食物。终于有一天猎人再也不能忍受,把他们扫地出门,因为猎人更需要身强力壮的猎狗。。。。。

--------------------- Birth of MicroBone Co. --------------

被扫地出门的老猎狗们得了一笔不菲的赔偿金,于是他们成立了MicroBone公司。他们采用连锁加盟的方式招募野狗,向野狗们传授猎兔的技巧,他们从猎得的兔子中抽取一部分作为管理费。当赔偿金几乎全部用于广告后,他们终于有了足够多的野狗加盟。公司开始赢利。一年后,他们收购了猎人的家当...[幽默家电子

杂志] http://www.efunster.com

------Development of MicroBone Co. -----------------------

MicroBone公司许诺给加盟的野狗能得到公司n%的股份。这实在是太有诱惑力了。这些自认为是怀才不遇的野狗们都以为找到了知音:终于做公司的主人了,不用再忍受猎人们呼来唤去的不快,不用再为捉到足够多的兔子而累死累活,也不用眼巴巴地乞求猎人多给两跟骨头而扮得楚楚可怜。这一切对这些野狗来说,这比多吃两根骨头更加受用。于是野狗们拖家带口地加入了MicroBone,一些在猎人门下的年轻猎口也开始蠢蠢欲动,甚至很多自以为聪明实际愚蠢的猎人也想加入。好多同类型的公司象雨后春笋般地成立了,BoneEase, Bone.com, ChinaBone....一时间,森林里热闹起来。(to be continued...)

------------------- F4 的诞生 ----------------------------

猎人凭借出售公司的钱走上了老猎狗走过的路,最后千辛万苦要与MicroBone公司谈判的时候,老猎狗出人意料的顺利答应了猎人,把MicroBone公司卖给了猎人。老猎狗们从此不再经营公司,转而开始写自转《老猎狗的一生》,又写:《如何成为出色的猎狗》,《如何从一只普通猎狗成为一只管理层的猎狗》《猎狗成功秘诀》《成功猎狗500条》《穷猎狗,富猎狗》,并且将老猎狗的故事搬上屏幕,取名《猎狗花园》,四只老猎狗成为了家喻户晓的明星F4. 收版权费,没有风险,利润更高。

ps: 干活的总是拿得少的,拿得多的都是不干活的。

 

标签:管理 | 浏览数(1817) | 评论数(1) | 2006-07-30
管理者需要掌握哪些财务知识(转载)  

一直以来,财务知识就是很多由技术、市场出身的管理者的短板,相信wlj也面临这样的问题,正在恶补财务知识吧,找到一篇比较简介明快的东西,送给Quack和其他有这方面需求的管理者,其实我自己就是一个需要在财务方面好好提高一下的人。:)

 

下载:管理者需要掌握哪些财务知识

标签:管理,资料 | 浏览数(2044) | 评论数(4) | 2006-07-29
管理故事-留个缺口给别人(转载)  

留个缺口给别人(转载)
 

      一位著名企业家在作报告,一位听众问:“你在事业上取得了巨大的成功,请问,对你来说,最重要的是什么?”  

      企业家没有直接回答,他拿起粉笔在黑板上画了一个圈,只是并没有画圆满,留下一个缺口。他反问道:“这是什么?”“零”。“圈”/“未完成的事业”/“成功”,台下的听众七嘴八舌地答道。

      他对这些回答未置可否:“其实,这只是一个未画完整的句号。你们问我为什么会取得辉煌的业绩,道理很简单:我不会把事情做得很圆满,就像画个句号,一定要留个缺口,让我的下属去填满它。”

  
      留个缺口给他人,并不说明自己的能力不强。实际上,这是一种管理的智慧,是一种更高层次上带有全局性的圆满。  给猴子一棵树,让它不停地攀登;给老虎一座山,让它自由纵横。也许,这就是企业管理用人的最高境界。 

标签:管理 | 浏览数(1643) | 评论数(2) | 2006-07-19
小企业,也咨询?  

2006年,我们听到“管理咨询”这个词可能比任何一年都要多。从7799到SOX,从金融到税务,从大机构到小企业,很多人都投向了咨询公司和咨询顾问的怀抱,咨询是否真的能带来效益我不敢肯定,不过咨询的旋风正在四处扩散是不争的现实。

我哥哥是从事传统行业-装饰材料-生意的,他也算是进入这个行业比较早的,大概从80年代末、90年代初就开始进入,也在广州驻在了几年,对这个行业还算是比较了解,经营范围从原来的给别人打工、对缝,到自己有自己的床位、自己有自己的库房、门市,生意也是越做越大。

他也是比较有激情那种人,随着生意的发展,在中国家具城比较早的做了自己的网站:嘉兴窗饰(www.jia-xing.cn);并且和我嫂子开始对员工进行了一些早期的企业发展、企业文化方面的管理和投资,而且前一段听说还在自费的读MBA,有点过份。

前几天突然给我电话,告诉我在三好街呢,我很纳闷,平时忙的从来不离开中国家具城的他怎么这么有空?告诉我正在做一个管理咨询的项目,请了某个咨询公司在做企业管理、企业发展方面的咨询。

嘿,挺出乎我的意料!虽然这几年哥哥的生意小有成就,但是我想能够在普遍素质不是很高的装饰材料这个传统行业能够有这样的理念的人也不是很多。

过后和哥哥聊了很多,他对自己的企业也有很多的思考和想法,也是踌躇满志,跃跃欲试!

我又对于咨询公司的各个方面进行了一些了解,也将咨询中容易出现问题的地方、容易导致咨询失败的地方告诉了他。

一段时间之后,再看到他,依然兴致勃勃,充满拼劲,看样子还咨询得挺美!

不能不说管理咨询的触角已经开始伸向中小企业了,你 做好准备了吗?

标签:管理,IT业界 | 浏览数(2132) | 评论数(0) | 2006-07-19
并不是你想象中那样(转载)  

并不是你想象中那样(转载)


      两个旅行中的天使到一个富有的家庭借宿。这家人对他们并不友好,并且拒绝让他们在舒适的客人卧室过夜,而是在冰冷的地下室给他们找了一个角落。当他们铺床时,较老的天使发现墙上有一个洞,就顺手把它修补好了。年轻的天使问为什么,老天使答到:“有些事并不象它看上去那样。”
  第二晚,两人又到了一个非常贫穷的农家借宿。主人夫妇俩对他们非常热情,把仅有的一点点食物拿出来款待客人,然后又让出自己的床铺给两个天使。第二天一早,两个天使发现农夫和他的妻子在哭泣,他们唯一的生活来源——一头奶牛死了。年轻的天使非常愤怒,他质问老天使为什么会这样,第一个家庭什么都有,老天使还帮助他们修补墙洞,第二个家庭尽管如此贫穷还是热情款待客人,而老天使却没有阻止奶牛的死亡。
  “有些事并不象它看上去那样。”老天使答道,“当我们在地下室过夜时,我从墙洞看到墙里面堆满了金块。因为主人被贪欲所迷惑,不愿意分享他的财富,所以我把墙洞填上了。昨天晚上,死亡之神来召唤农夫的妻子,我让奶牛代替了她。所以有些事并不象它看上去那样。”

 

『评论』有些时候事情的表面并不是它实际应该的样子。如果你有信念,你只需要坚信付出总会得到回报。你可能不会发现,直到后来……

在我们做项目的时候更是这样,我们会从方方面面得到许多的信息和线索,如何理清头绪、如何找到正确的那个线头,是需要我们具有一双慧眼的......

标签:管理 | 浏览数(1753) | 评论数(2) | 2006-05-30
爱人之心(转载)  

爱人之心(转载)      

 

       这是发生在英国的一个真实故事。

  有位孤独的老人,无儿无女,又体弱多病。他决定搬到养老院去。老人宣布出售他漂亮的住宅。购买者闻讯蜂拥而至。住宅底价8万英镑,但人们很快就将它炒到了10万英镑。价钱还在不断攀升。老人深陷在沙发里,满目忧郁,是的,要不是健康情形不行,他是不会卖掉这栋陪他度过大半生的住宅的。

  一个衣着朴素的青年来到老人眼前,弯下腰,低声说:“先生,我也好想买这栋住宅,可我只有1万英镑。可是,如果您把住宅卖给我,我保证会让您依旧生活在这里,和我一起喝茶,读报,散步,天天都快快乐乐的——相信我,我会用整颗心来照顾您!”

  老人颔首微笑,把住宅以1万英镑的价钱卖给了他。

 

『评论』完成梦想,不一定非得要冷酷地厮杀和欺诈,有时,只要你拥有一颗爱人之心就可以了。

标签:管理 | 浏览数(1874) | 评论数(1) | 2006-05-30

Powered by Haiwit