Firebird Docwriting Guide Brazilian Portuguese

• 语言: 葡萄牙语
• 格式: .pdf
• 来源: firebirdsql.org

摘要

Este documento é uma guia para escrever documentação para o projeto Firebird, utilizando o formato DocBook XML. Ele aborda pré-requisitos, estruturação de documentos, elementos do DocBook XML, ferramentas disponíveis e como contribuir para o projeto. Também inclui informações sobre a licensa pública de documentação, histórico do documento e orientações para participar da lista de discussão firebird-docs.

AI总结

### 总结

#### 1. **许可证信息**
- 文档内容受《公共文档许可证》（Public Documentation License 1.0）保护。
- 许可证文本可访问：[PDF](http://www.firebirdsql.org/pdfmanual/pdl.pdf) 和 [HTML](http://www.firebirdsql.org/manual/pdl.html)。
- 原始文档标题为《Firebird Docwriting Guide》。
- 初始作者：Paul Vinkenoog。
- 巴西葡萄牙语翻译者：Fabrício Pontes de Araújo。
- 版权所有：2003-2005年，保留所有权利。

#### 2. **文档历史**
- 初始版本（0.1）于2004年1月17日发布，标题为《Writing Documentation for Firebird》。
- 完整版本（0.2）于2004年1月27日完成，并于2004年3月8日正式发布。
- 1.1版本于2005年2月26日更新，新增内容包括：
- 修改标题为《Guia de escrita de documentação para o Firebird》。
- 添加PostgreSQL文档部分。
- 解释XML术语。
- 总结DocBook的优势。
- 修改章节元素建议。
- 添加历史记录和修订号。

#### 3. **文档目的与目标读者**
- 指导编写Firebird文档的人员。
- 适用于希望为Firebird项目贡献力量的个人。

#### 4. **先决条件**
- 了解Firebird手册模块。
- 熟悉CVS的使用，包括下载和更新手册模块。
- 知晓如何生成当前下载模块的手册。

#### 5. **主要内容**
- **讨论主题**：
- Firebird文档列表（firebird-docs）的使用。
- 选择和组织写作主题。
- DocBook XML格式的介绍。
- 文档提交与管理流程。
- **DocBook XML**：
- 作为Firebird文档的标准格式，因其结构清晰、适合技术文档而被选用。
- 主要工具包括XMLMind XML Editor等。
- 基本元素包括章节、段落、标题等。
- **写作建议**：
- 在开始写作前，先制作详细提纲。
- 在firebird-docs列表中分享提纲，寻求反馈。
- 确保所有信息在写作前准备完毕。

#### 6. **规则与注意事项**
- **ID唯一性**：同一文档集中ID必须唯一。
- **命名约定**：章节和段落ID应以统一前缀开头（如`usersguide-`）。
- **结构顺序**：先定义需要读者掌握的内容，再按逻辑顺序组织章节。

#### 7. **提交指南**
- 文档需以DocBook XML格式提交至CVS模块。
- 获得提交权限需通过firebird-docs列表申请。
- 提交后需遵守项目规则。

#### 8. **资源与联系方式**
- **邮件列表**：订阅firebird-docs列表，地址为。
- **新闻组**：访问news.atkin.com，查看相关组（如sourceforge.firebird.doc）。
- **项目页面**：访问[Firebird文档页面](http://www.firebirdsql.org/index.php?op=devel&sub=doc)获取最新信息。

#### 9. **贡献指南**
- **选择主题**：确保主题未被覆盖，优先选择熟悉或感兴趣的内容。
- **交流讨论**：在firebird-docs列表中分享写作计划，寻求建议和合作机会。

#### 10. **总结**
- 该文档为Firebird项目提供了详细的写作指南，涵盖从准备到提交的全过程。
- 强调使用DocBook XML格式和遵守项目规范的重要性。
- 提供了丰富的资源和联系方式，便于贡献者参与项目。