文档写作入门》的相关内容

『思考』为什么老外的注释和文档普遍比国人好得多?欢迎讨论

注释和文档是程序质量的一个极其重要的部分,怎么强调也不为过 大家可能都有这样的体验:看老外的程序是一种享受,看(维护)国人的程序是一种苦差。除了编码水平的问题,注释文档是一个明显的区别:老外的注释详尽,常常是注释多于程序本身,如jdk的一些类,接口;国人的程序往往注释极少,甚至就没有。原因何在? 我们都知道注释文档的重要性,但好象又没有受到约束。很多公司提倡的代码的互测和自测只是说说而已,没有 ...
by steve_gu 2004-07-19 浏览 (23236) 回复 (65) 关键字:

与高手交流的一个陷阱

与高手交流,经常容易陷入的一个陷阱是他们往往都有一些自己心爱的工具(古龙:七种武器)。他们非常喜欢谈论使用某种工具后开发效率有了显著的提升,而且深深以自己使用的工具为傲,似乎你没有用这种工具就完全没有与他进行交流的共同词汇。 这种倾向经常使初学者忙不迭地找来那种工具学习掌握,等到好不容易用熟了,却发现并不一定有那么神奇的功效而感到失望。我发的“什么是软件开发的核心问题”的帖子就是想提醒大家要把主要 ...
by dlee 2003-12-06 浏览 (23528) 回复 (41) 关键字:

FDD——天才的灵感

实际上大家并不知道FDD的agile方法的法律地位是很值得推敲的——至少你看那17个人中间没有Jeff De Luce和Peler Coad(http://www.agilemanifesto.org/)。而且即使是Jon Kern也是在相信agile对于建模的态度是友好的(至少MDA的Steve Mellor也这样认为),而且Together soft可以减小建模和编码之间的断层隔离。当然类似的 ...
by ozzzzzz 2006-10-08 浏览 (17460) 回复 (36) 关键字: fdd

[原创]定论——软件开发的评价标准(1)

一、序论 我们一直在争论,什么更好。 什么是更好的语言,什么是更好的写法,什么是更好的设计,什么是更好的风格,什么是更高的框架,什么更好的工具...... 没有定论,似乎没有什么能够占绝对的上风,往就是陷入混战,边上还有人劝架:“具体情况具体分析嘛,这样凭空吵不出结果的!” 能不能得到定论呢? 首先要明确,标准是什么?或者说软件开发的根本目标,除了满足功能需求之外,对于软件开发的这一方来说 ...
by 庄表伟 2004-04-20 浏览 (26151) 回复 (47) 关键字:

文档的价值?

前言: 提起软件工程、ISO体系、CMM、RUP,甚至项目管理,都会给人一种强化控制的感觉:要写一堆文档,要填写一堆的报表,要经常开会评审……。 现在软件工厂、蓝领之类的观点颇有市场,一些专家鼓吹通过过程控制、文档驱动、蓝领开发来进行软件项目开发。 这种思想的基础:文档驱动、装配流水线我个人认为是错误的。先说说文档,装配线的事还得准备一段时间。 文档的价值 文档的价值真有那么大吗?我赞成写文档, ...
by 一蓑烟雨任平生 2004-06-23 浏览 (6436) 回复 (14) 关键字:

XML学习手册

提纲 本文共分五大部分。分别是XML快速入门,XML的概念,XML的术语,XML的实现,XML的实例分析。最后附录介绍了XML的相关资源。作者站在普通网页设计人员的角度,用平实生动的语言,向您讲述XML的方方面面,帮助你拨开XML的神秘面纱,快速步入XML的新领域。 第一章:XML快速入门 一. 什么是XML? 二. XML是新概念吗? 三. 使用XML有什么好处? 四. XM ...
by 夏日影画 2006-11-06 浏览 (290) 回复 (0) 关键字: XML轻松学习手册

XML快速入门

XML越来越热,关于XML的基础教程网络上也随处可见。可是一大堆的概念和术语往往让人望而生畏,很多朋友问我:XML到底有什么用,我们是否需要学习它?我想就我个人学习过程的心得和经验,写一篇比较全面的介绍文章。首先有两点是需要肯定的: 第一:XML肯定是未来的发展趋势,不论是网页设计师还是网络程序员,都应该及时学习和了解,等待只会让你失去机会; 第二:新知识肯定会有很多新概念,尝试理解和接受,您才可 ...
by roruby 2004-10-09 浏览 (50) 回复 (0) 关键字:

XML入门

XML越来越热,关于XML的基础教程网络上也随处可见。可是一大堆的概念和术语往往让人望而生畏,很多朋友问我:XML到底有什么用,我们是否需要学习它?我想就我个人学习过程的心得和经验,写一篇比较全面的介绍文章。首先有两点是需要肯定的:                第一 ...
by dhj 2008-03-20 浏览 (134) 回复 (0) 关键字:

XML快速入门

Xml越来越热,关于Xml的基础教程网络上也随处可见。可是一大堆的概念和术语往往让人望而生畏,很多朋友问我:Xml到底有什么用,我们是否需要学习它?我想就我个人学习过程的心得和经验,写一篇比较全面的介绍文章。首先有两点是需要肯定的: 第一:Xml肯定是未来的发展趋势,不论是网页设计师还是网络程序员,都应该及时学习和了解,等待只会让你失去机会; 第二:新知识肯定会有很多新概念,尝试理解和接受 ...
by sumongh 2007-05-22 浏览 (336) 回复 (0) 关键字: XML

10技巧创建软件开发文档

虽然编制文档并不是众多IT专业人员选择职业的真正原因,但是足够的激情、勤奋工作和注意细节将会使你成为老板的一份更具价值的资产并能够提升你的履历。 本文我们介绍了取自10 Things博客中的文章《创建软件文档的10项技巧》。该博客主要面向应用开发专业人员,但是项目经理和管理人员也可以从他们的智慧中获益。 Alan Norton从事软件系统开发和相应软件项目文档编制工作很多年。我们可以从他的多年 ...
by liyiye 2008-09-18 浏览 (80) 回复 (0) 关键字:

google search

这篇文章中,我们介绍了google,它是一个大型的搜索引擎(of a large-scale search engine)的原型,搜索引擎在超文 本中应用广泛。Google的设计能够高效地抓网页并建立索引,它的查询结果比其它现有系统都高明。这个原型的全文和超连接的数据库至少包含24‘000 ‘000个网页。我们可以从 http://google.stanford.edu/ 下载。 设 计搜索引擎 ...
by dogstar 2008-05-29 浏览 (628) 回复 (0)

[zz]软件架构师成长之路

对于任何一个软件开发人员来说,架构师都是一个令人向往的角色。就连世界首富比尔盖茨在2000年卸任公司CEO的同时,也担任了微软公司的荣誉角色“首席软件架构师”,可见“架构师”这一称谓的吸引力。架构师是公司的“金领”,有着非常高的收入,很少需要考虑生存的问题,从而有更多的精力思考关键技术问题,形成“强者愈强”的良性循环。部分优秀的开发人员在工作了一定时间后,就要开始考虑自己的未来到底向哪个方向发展。 ...
by imjl 2007-08-10 浏览 (1213) 回复 (6)

轻量级web服务器

轻量级 Web 服务器 最近几年,市场上出现了很多有趣的 Web 服务器实现,包括 lighthttpd、litespeed 和 mongrel 等。这些 Web 服务器都宣称结合了性能、易管理性、可移植性、安全性和其他相关价值。下面的工程研究将调查轻量级 Web 服务器,以帮助您选择最可能满足下一个项目的技术需求的 Web 服务器。 “轻量级” Web 服务器,例如 lighthttpd、 li ...
by dogstar 2008-05-29 浏览 (604) 回复 (2)

google背后的分布式架构

Google背后的分布式计算架构策略 Google是与众不同的。它的独特不仅仅表现于革新的思维和充满创意的应用 (比如那个大堂里的地球模型),更在于其有别常规的IT策略……   加利福尼亚州山景城(Mountain View)Google公司(Google,下称Google)总部有一个43号大楼,该建筑的中央大屏幕上显示着一个与Google地球(Google Earth)相仿的世界地图,一个转动 ...
by dogstar 2008-05-29 浏览 (2052) 回复 (0)

游戏引擎剖析

游戏引擎剖析 原文作者:Jake Simpson 译者: 向海 Email:GameWorldChina@myway.com   第1部分: 游戏引擎介绍, 渲染和构造3D世界   介绍     自Doom游戏时代以来我们已经走了很远。 DOOM不只是一款伟大的游戏,它同时也开创了一种新的游戏编程模式: 游戏 "引擎"。 这种模块化 ...
by iamzealotwang 2008-10-06 浏览 (58) 回复 (9)

《CSS实战手册》中文版发布

  10年前,当我在记事本中一点一滴地书写着HTML、JavaScript、CSS并保存,然后在浏览器里预览自己的杰作时,感觉这是那么神奇、有趣!   10年后的今天,当Web 2.0的概念已经遍地开花结果时,从1996年提出的CSS 1,到即将出现的CSS 3,我们难免不联想到Web 3.0的蠢蠢欲动了。   没有CSS的手册,人们常常不知道从哪里入手学习CSS。好的CSS点子甚至可以胜过经验 ...
by YuLimin 2007-10-24 浏览 (3406) 回复 (7) 关键字: CSS Hack Bug

Hibernate 3.3.0GA 中的中文文档,并非满江红打包

今天Hibernate 放出了3.3.0GA。其中内附的中文文档,包含了html, html_single, pdf三个格式。但它们出现了很多错误: 1,pdf乱码。index是正确的,但是内容不正确。 2, html中第13章乱码。 3,中文内容实际未得到任何更新。3.2 到3.3版本新加入的英文,仍然以英文形式出现。 事情是这样的,之前(3.2之前),我每次更新中文文档,都会将更新后的 ...
by 曹晓钢 2008-08-18 浏览 (4525) 回复 (23) 关键字: hibernate

JavaScript创始人Brendan Eich访谈录

简介 Brendan  Eich于1995年在Netscape发明了JavaScript语言,这个语言在过去的一些年里曾是一个最被误解的语言,随着AJAX和Web  2.0的发展,人们逐渐正视JavaScript。这是一篇Computerworld对Brendan  Eich的一次采访,对JavaScript的过去、现在和未来都做了阐述。 是什么促使你去开发Java ...
by wutao0603 2008-09-09 浏览 (913) 回复 (0) 关键字: javascript创始人

相关问答

赞助商链接