Firebird Docwriting Guide Brazilian Portuguese
161.44 KB
36 页
0 评论
语言 | 格式 | 评分 |
---|---|---|
葡萄牙语 | .pdf | 3 |
摘要 | ||
O documento fornece uma guia detalhada para contribuir com a documentação do projeto Firebird. Ele aborda tópicos como a utilização do formato DocBook XML, a importância do CVS para gerenciar o módulo de manuais, a participação na lista de discussão firebird-docs, e a necessidade de conformidade com a Licensa de Documentação Pública. Além disso, o guia oferece orientações práticas sobre como escrever e submeter documentos, incluindo a utilização de elementos do DocBook, direitos autorais e a integração de documentos do PostgreSQL. O objetivo principal é capacitar os contribuintes a criar documentação de qualidade para o Firebird. | ||
AI总结 | ||
以下是对文档内容的简要总结:
### 《Firebird 文档编写指南(巴西葡萄牙语版)》
#### 介绍
- **目的**:本文档讨论了为 Firebird 项目编写文档的各个方面,旨在帮助希望为 Firebird 编写文档或考虑加入该项目的人快速上手。
- **目标读者**:希望为 Firebird 项目编写文档的人。
- **前提条件**:
- 了解 Firebird 手册模块。
- 熟悉 CVS 及其客户端的使用,能够从 CVS 检出当前手册模块。
- 知道如何生成手册模块文档。
#### 主要内容
1. **Firebird 文档编写指南**
- **讨论的主题**:
- firebird-docs 邮件列表。
- 如何选择一个主题并准备大纲。
- DocBook XML 的基础知识。
- 使用工具创建 DocBook XML 文档。
- 语言风格和版权问题。
- 如何将文档添加到 Firebird 手册模块中。
2. **Domotics XML 简介**
- **什么是 Domotics XML**:
- 了解 Domotics XML 的基本概念和常见用途。
- **为什么选择 Domotics XML**:
- 高效的结构化文档格式,适合技术文档编写。
- **工具推荐**:
- 列举了常用的工具,如 XML 编辑器、生成工具等。
3. **编写文档**
- **创建和编辑文档**:
- 如何创建新文档。
- 常用元素的使用方法。
- **非技术性建议**:
- 语言风格的选择。
- 版权和许可证的注意事项。
4. **使用 PostgreSQL 文档**
- PostgreSQL 文档的结构和许可证要求。
- 如何引用 PostgreSQL 文档并正确标注许可证信息。
5. **提交文档**
- **添加文档到手册模块**:
- 检查文档是否正确生成。
- 提交流程:初次提交需审查,之后可直接提交。
- **请求提交权限**:
- 需要 SourceForge 账户。
- 通过邮件列表申请提交权限。
#### 附录
- **历史记录**:
- 记录了文档的修改历史。
- **许可证声明**:
- 本文档采用公共文档许可证(PDL),需遵守许可证条款。
#### 总结
本文档为 Firebird 项目的文档编写者提供了全面的指导,涵盖从准备工作到提交文档的完整流程,并重点介绍了 DocBook XML 的使用。通过阅读本文档,读者可以掌握必要的知识和技能,顺利参与 Firebird 文档的编写工作。 |
P1
P2
P3
P4
P5
P6
P7
下载文档到本地,方便使用
- 可预览页数已用完,剩余
29 页请下载阅读 -
文档评分