帮助文档制作说明

合集下载

帮助文档编写规范

帮助文档编写规范

帮助文档编写规范
1.所有帮助文件必须以“Help+欲说明文件文件名”为其文件名,例:为OfficeIntrnet中事务提示“prompt.asp”编写的帮助文件其文件名为“HelpPrompt.asp”
2.若欲编写之帮助文件在一帧页中,则帮助文件名为“Help+帧面文件名”。

例:为OfficeIntranet中的名片管理编写帮助文件时,其帧页文件名为“Card.asp”,浏览页文件名为“Cardcontent.asp”,状态选择页文件名为“Cardlist.asp”,此时只能将帮助文件名定为“Helpcard.asp”,而浏览页与状态选择页的帮助文件均写在此页中即可。

3.编写好的帮助文件均需放在“Help”文件夹中。

注意:若是为“系统管理”编写的帮助文件则放在“Help/System”文件夹中。

4.新编帮助文件的页面及标题请按下述规范格式编写:
<BODY topmargin=10 leftmargin=5>
<center><h4><font color="<%=session("TitleColor1")%>">考勤管理</font></h4></center>。

help workshop制作帮助文件

help workshop制作帮助文件

用微软help workshop制作帮助文件提交日期:2003-12-23 浏览: 258用微软help workshop制作帮助文件制作帮助文件主要有以下几个步骤完成:*利用Word软件制作帮助文件的原始说明文件(.rtf)。

*利用Hcw软件制作帮助文件的书签索引文件(.cnt)。

*利用Hcw软件建立工程文件(.hpj)。

*在工程文件中将说明文件和索引文件编译成帮助文件(.hlp)。

一、制作帮助文件的原始说明文件说明文件的书写要遵循一定的格式,说明文件一般由标题区、脚注区和正文区组成。

1) 标题区:标题区是书写帮助文件每一章节的提头说明,它在阅读时不放在滚动条内。

2) 脚注区:在帮助文件每一个标题的开始加上脚注,常用的有以下几种符号:$帮助文件浏览时记录的标题信息,放在书签菜单中,并可通过“《、》”按钮循环观看,一般用每一章的标题记录。

#帮助文件每个标题的ID值,通过它可以标识每个说明标题,通过它来和其他的跳转以及书签索引文件取得联系。

K 与每个标题相关的关键字,以后显示在进入帮助文件的树状图中,通过它可快速找到所要查询主题。

+浏览帮助文件时每页的顺序。

3) 正文区:正文区用来编写帮助文件的主要部分,每个标题的内容写完以后,都要插入一个分页符,以便和下一个标题内容分开。

其特殊格式如下:跳转:跳转用双下划线字体表示,后跟要跳转到某个标题的ID值,要用隐藏字体。

旁注:旁注指用鼠标单击后弹出的一小段注释,用单下划线字体表示,后跟要跳转到某个标题的ID值,要用隐藏字体。

位图:位图指在帮助文件中插入bmp格式的图片,可以直接在WORD文档中插入,也可用下列命令表示:{bmc filename.bmp}热点:热点指用鼠标单击后跳转去执行一个宏命令,可以在跳转后跟叹号和宏命令,要用隐藏字体,如果是位图热点,也可在Hotspot软件中去制作,如下所示:画笔!Exec(paint.exe) 插入一个文字热点{bmc paint.bmp}!Exec(paint.exe) 插入一个位图热点。

如何制作帮助手册

如何制作帮助手册

如何制作帮助手册制作帮助手册是为了指导用户正确使用产品或系统提供的功能和服务。

一份好的帮助手册应该清晰明了,易于理解,内容全面详细,并且能够解答用户可能遇到的问题。

以下是制作帮助手册的一些建议和参考内容,供参考:1. 简介与目的:在帮助手册的开头,简要介绍产品或系统的背景和目的。

明确说明这份手册的用途,帮助用户了解它对他们的重要性和意义。

2. 内容结构:帮助手册的内容应该被合理地组织和分段。

用户可以根据不同的主题快速找到需要的信息。

一种通用的结构是按照功能进行分类,并在每个功能下详细说明其相关操作步骤。

3. 常见问题解答:在帮助手册中,可以列出一些常见问题和解答。

这些问题应该是用户可能会遇到的问题,以及解决问题的方法和步骤。

可以采用问答的形式,让用户能够快速查找到自己遇到的问题。

这部分内容可以放在手册的最后,作为问题的汇总和解答。

4. 图文并茂:使用图片和图表可以更好地解释使用步骤和操作方法。

在关键的操作步骤中加入相关的图片,可以使用户更直观地理解和跟随。

同时,为了支持视觉障碍用户,必须保证文本的清晰和易读性。

5. 注意事项:帮助手册还应提供一些注意事项,以避免用户犯错或出现其他问题。

这些注意事项可以是一些特殊的配置要求,或是使用过程中需要注意的细节。

在操作步骤中也可以加入提示和警示,以提醒用户注意。

6. 示例和案例:为了更好地帮助用户理解如何使用产品或系统,可以通过示例和实际案例来说明。

这些示例和案例应该是真实的,具有实际价值,能够帮助用户理解如何应用在实际场景中。

7. 更新和版本:随着产品的不断更新和演进,帮助手册也需要及时更新。

在手册的结尾,可以提供版本信息和更新历史,以便用户了解当前手册的准确性和适用性。

总的来说,一份好的帮助手册应该着重于用户的需求和使用体验,做到以用户为中心。

通过清晰的结构和详细的操作步骤,让用户能够轻松地找到需要的信息,并正确地使用产品或系统。

同时,手册的内容还应该易读易懂,避免使用过于专业化的词汇和术语,以适应各种技术水平的用户。

CHM帮助文档制作教程

CHM帮助文档制作教程
在 Microsoft 公司推出 Windows 98 视窗系统的时候,就同时推出了一种基于 HTML 文件特性的帮助文件系统,这就是 CHM,CHM 是用来替换早先 的 winhelp 文件系统。在 CHM 文件的属性中我们可以看到 CHM 的类型是“已编译的 HTML 帮助文件”,其实 Internet Explorer 支持的 JavaScript、 VBScript、ActiveX、Java Applet、Flash、HTML 图像文件(GIF、JPEG、PNG)、音频视频文件(AU、MIDI、WAV、AVI)等等,CHM 文件也同样支持。 正因为它有如此多的特性,理所当然的成为我们制作多媒体电子书籍的首选格式。
后续 ............................................................................................................................................ 20 后续及相关说明 .................................................................................................................... 20
2
CHM 帮助文档制作教程
二:准备工作
制作 CHM 文件的工具有很多种:“HTML Help WorkShop”、“Visual CHM”、“chm 制作精灵”、“电子文档处理器(eTextWizard)”、 “Easy CHM”等,这里就以“Easy CHM”为例。
开始制作 CHM 文档之前,我们必须准备好“原材料”: 一是 HTML 格式的网页文件(即:静态网页),制作 HTML 文件的软件很多我们最常用的有 FrontPage、Dreamweave(这里就不再介绍静态页面制 作了)。 二是“Easy CHM”软件。因为下载地址会CHM 文件的窗口格式:打开记事本帮助,可以看到窗口分为三个部分,顶层是功能按钮,右边是主窗口,左边是导航窗口,看上去 CHM 窗口十分简洁美观。这些窗口和按钮的格式都可以在 Easy CHM 中设置、更改。

编写帮助文档图文教程

编写帮助文档图文教程

Manual and Help使用指南EC Software 公司的 Help & Manual 作为一个出色的帮助文件制作软件,它有着很多强大而实用的功能。

首先,Help & Manual 能够生成五种不同格式的通用帮助文件:从Windows 3.X到Windows XP都能识别的经典HLP格式帮助文件、电子手册(RTF)、HTML格式文件、可执行文件EXE格式文件,Adobe 公司的PDF文件格式(如图1),以及代表着未来帮助文件发展趋势的CHM格式文件(需要Microsoft Html Help WorkShop支持)。

其次,Help & Manual 具有图片插入、AVI等多媒体插入、OLE 超链接、书签设置以及插入宏等强大的链接扩展功能,可以让你制作出更为漂亮活泼、跳转灵活的帮助文件。

在完成一个帮助文件后,你还可以利用Help & Manual十分方便地进行文件预览、对多个帮助文件进行合并集成、文件打印等操作,另外,Help & Manual还提供了屏幕截图和拼写检查功能。

在最新的3.0版中,操作比2.0版方便多了。

单击“File | New”进入后有一个对话框(如图2),在这里可以选择是新建一工程,还是从众多的支持格式中导入(有HLP格式文件和HLP源文件、CHM格式和RTF格式),单击“Next”,我们以“创建一个新工程”为例明说一下它的用法。

设置好工程保存的位置和名称,选择好模板后,单击“Next”,在此处直接粘贴已编写好的目录文字(图3)。

单击“Finish”后,即可看到在目录树(Table of Contents)显示框内已经按照你所输入的文本建立好了目录结构。

先在Topic Options 框内填入相应内容,然后在Help Text 框输入(粘贴)需要写入的文档,并对每一项帮助进行说明。

如果你还需要加入宏、图片、多媒体等链接,可以直接在Insert菜单下选择相应的操作。

CHM帮助文档制作教程

CHM帮助文档制作教程

CHM帮助文档制作教程该文档中,我以制作C#编程语言的学习文档为例:(本人亲测有效)一、前期准备工具1、软件:WinCHM、Microsoft office Word20162、基础文件:HTML格式的文件二、CHM制作过程1、WinCHM软件:该软件直接在浏览器搜索下载即可,这里就不再赘述了;2、HTML文件的制作过程:1)制作文件夹等级:●先建立文件夹,该文件夹是总的文件夹,比如我想做C#编程语言的,第一个文件夹就是C_Shap;注意文件夹的命名。

最好只用数字、字母、下划线组成的格式;不要包含#、$等等特殊符号,否则会导致后面导出的CHM文件无法正确显示。

●建立各章节目录的子文件夹:每一个章节建立一个子文件夹同时养成一个好习惯,就是在文件夹或者文件命名的时候,保持一定的规律或者规则;不要花里胡哨的。

2)建立HTML文档将你文档的各章节复制粘贴到Word2016中,将图片格式左对齐(为了导出的CHM格式整齐一点),在Word2016中将文件另存为HTML格式的文档;详细操作如下图:将文件内容复制粘贴到word中:将其另存为HTML格式文件(网页格式的文件):将我们导出的文件存放到我们最开始建立的文件夹中,注意各章节对应(第一章节的文档存入第一章节的文件夹),后续其他章节全部都是一样的操作过程,这里不再赘述。

到此,我们HTML文件就制作完成了;3)开始制作CHM文档打开WinCHM软件,新建项目,选择使用现有的HTML创建一个新项目:将我们制作好的.htm文件导入进去(一般我们只需要选择第一个文件夹就可以,不需要详细到每一个.htm文件,也就是说路径中只需要选择到第一个文件夹就好),这样就导入了.htm文件,如图:最左边的上下左右四个箭头,用来调整我们文档里章节的位置及顺序,因为文档最初导入进来的时候,顺序是打乱的,使用箭头工具调整好即可;同时我们也发现,最初我们建立的文件夹梯度顺序,在WinCHM里面,变成了我们文档的各章节的标题或者目录(如果没有目录的话,就自己将章节名称重命名即可)4)导出CHM文档点击构建选择CHM,或者直接选择CHM文档,导出这里一般不需要做修改,直接导出即可。

帮助文档的制作说明

帮助文档的制作说明

你知道现在最流行的电子书籍是什么格式吗?不知道!没关系看看你的Windows 98或Windows 2000帮助文件是什么格式,你就应该知道了。

这是一种文件后缀为CHM、文件类型为“已编译的 HTML 帮助文件”,呵呵,HTML不就是我们现在在网络上所浏览的网页格式吗!现在我们来认识认识CHM吧。

在Microsoft公司推出Windows 98视窗系统的时候,就同时推出了一种基于 HTML 文件特性的帮助文件系统,这就是CHM,CHM是用来替换早先的winhelp 文件系统。

在CHM文件的属性中我们可以看到CHM的类型是“已编译的 HTML 帮助文件”,其实Internet Explorer 支持的 JavaScript、VBScript、ActiveX、Java Applet、Flash、HTML 图像文件(GIF、JPEG、PNG)、音频视频文件(AU、MIDI、WAV、AVI)等等,CHM文件也同样支持。

正因为它有如此多的特性,理所当然的成为我们制作多媒体电子书籍的首选格式。

制作 CHM 文件的最佳工具是微软的 HTML Help WorkShop,在本文中使用的是1.3版本,英文差的朋友下载一个汉化补丁安装一下就可以变成中文版了。

开始制作CHM文档之前,我们必须准备好“原材料”,那就是HTML格式的网页文件,制作HTML文件的软件很多我们最常用的有FrontPage、Dreamweaver。

先来看看CHM文件的窗口格式:打开Windows帮助,可以看到窗口分为三个部分,顶层是功能按钮,右边是主窗口,左边是导航窗口,看上去CHM窗口十分简洁美观。

这些窗口和按钮的格式都可以在HTML Help WorkShop中设置、更改。

CHM制作实例我用Dreamweaver配合HTML Help Workshop制作的一篇图文游戏攻略CHM 文档:最终完成后的样式首先设计出整篇攻略的结构,我的想法是:先建一个主页面,在上面放上游戏每一关的大图片,游戏共十关,再分别作十个页面,每个页面就具体介绍每关的攻略,在主页面作好进入每关页面的超连接,这样读者进入主页面后就可以自由的进入每一页面了。

服务帮助文档范文

服务帮助文档范文

服务帮助文档范文
一、介绍
欢迎使用我们的服务帮助文档。

本文档将向您提供一些使用我们服务的基本信息,以便您更好地享受我们的服务。

二、注册
1.注册流程
a.在我们的网站上找到注册页面,点击“注册”按钮。

c.点击“注册”按钮完成注册。

2.注册注意事项
a.用户名要求为8-20个字符,可以包含字母、数字和下划线。

b.密码要求为8-20个字符,至少包含一个大写字母、一个小写字母和一个数字。

三、登录
1.登录流程
a.在我们的网站上找到登录页面,输入用户名和密码。

b.点击“登录”按钮完成登录。

2.登录注意事项
a.登录时请确保用户名和密码的正确性。

b.如果忘记密码,可点击“找回密码”按钮进行密码重置。

四、服务列表
1.产品服务。

  1. 1、下载文档前请自行甄别文档内容的完整性,平台不提供额外的编辑、内容补充、找答案等附加服务。
  2. 2、"仅部分预览"的文档,不可在线预览部分如存在完整性等问题,可反馈申请退款(可完整预览的文档不适用该条件!)。
  3. 3、如文档侵犯您的权益,请联系客服反馈,我们会尽快为您处理(人工客服工作时间:9:00-18:30)。

一种制作帮助文档的方法
——world转CHM,CHM转HTML
现在做的项目或是产品中常要用到给用户一个用户手册或是操作手册的文档,大部分都以world文档或pdf文件形式,较少有用CHM各在线html格式的。

前段时间经理给我一份world格式的产品帮助文档要我把它做成在线网页面格式并放到产品(B/S结构)里,之前用过直接把world文档另存为htm格式的,可是文档太大,加载速度很慢,文档很长,查看不方便,后来又自己手动试着做过,可是做出的东西太烂,在网上找了一些生成CHM 的工具或是编辑CHM的工具,有的工具很好(即见即所得),有的要收费,即使有了还得把文档再编辑一遍,太麻烦了,终于在疯狂的搜索中找到了一种解决的方法。

在这里我总结一下自己做在线帮助文档的方法,和大家分享交流一下,希望大家能提出更好的方法,期待
中……
第一步准备好world文档,要求生成有目录的帮助文档(或是软件操作手册)。

第二步用Macrobject Word-2-CHM工具把world文档转成CHM文件。

生成的CHM文件格式如下图:
这里还有些问题,1.一级目录点击后右边是只有个标题,没有内容,如下图
2.可能还有些小的问题不是想要的或是生成的不对。

第三步用CHM Editor工具对所生成的CHM文件进行些修改和编辑。

第四步用chmdecoder.exe工具把CHM文件编译成HTML格式。

结构还算完整(有的工具反编译后是单个的html文件,不方便放出到工程里)。

之后就可以根据需要做一些小的改动就可以了。

相关文档
最新文档