首页
学习
活动
专区
工具
TVP
发布

中文技术文档的写作规范

很多人说,不知道怎么写文档,都是凭着感觉写。 网上也很少有资料,教你写文档。这已经影响了中文软件的发展。...英语世界里,文档非常受重视,许多公司和组织都有自己的文档规范,清楚地规定写作要求,比如微软、MailChimp、Apple、Yahoo、docker、Struts 等等(维基百科有一份完整的清单)。...中文的也有不少,但都不令人满意,要么太简单,要么不太适用。 我就动手,参考上面的规范,也结合自己的实践,总结了一份简单的《中文技术文档的写作规范》。...标题 文本 段落 数值 标点符号 章节结构 我希望,这样可以抛砖引玉,让更多人重视文档,进而真正出现大家普遍接受的文档规范。 下面是关于写作风格的一个片段。欢迎提交 Issue 和 PR 补充。...================================= 写作风格 (摘自《中文技术文档的写作规范》) 如果使用了被动语态,应考虑更改为主动语态。

1.7K100

中文全文检索技术路线(elasticsearch全文检索、中文分词ik、tika解析文档

github.com/3xxx/engineercms https://github.com/3xxx/engineercms 总体思路就是用docker安装es和tika服务,在cms里上传word之类文档...前端检索,在es里查询,返回高亮文本和结果列表,点击定位到文档打开。 es里安装ik插件,用head和postman或curl进行调试。...Content-Type: application/json" -d@2.json 2.json文件内容: { "analyzer": "ik_max_word", "text": "中华人民共和国国歌" } 中文分词...技术选型很重要,涉及将来的修改,前者是官方的,后者是作者个人维护的,star数后者是前者2倍,但都很庞大的star数。 前者的教程很少,只有它官方的example可以学习。本文用的就是。...apache/tika docker run -d -p 9998:9998 apache/tika: engineercms需要做的就是上传、提交检索数据结构、返回和前端展示…… 1.tika识别文档

74520
您找到你想要的搜索结果了吗?
是的
没有找到

keras中文文档

Keras:基于Theano和TensorFlow的深度学习库 详细的中文文档,目录如下: ? ? ?...以下内容摘自keras中文文档 这就是Keras Keras是一个极简和高度模块化的神经网络库,Keras由纯Python编写而成并基于Theano或Tensorflow。...请参考编写自己的层 ---- 关于Keras-cn 本文档是Keras文档中文版,包括keras.io的全部内容,以及更多的例子、解释和建议,目前,文档的计划是: 1.x版本:现有keras.io文档中文翻译...的同学,请移步 Keras安装和配置指南 ---- 在Theano和TensorFlow间切换 Keras默认使用Theano作为后端来进行张量操作,如需切换到TensorFlow,请查看这里 ---- 技术支持...batch 这个概念与Keras无关,老实讲不应该出现在这里的,但是因为它频繁出现,而且不了解这个技术的话看函数说明会很头痛,这里还是简单说一下。 深度学习的优化算法,说白了就是梯度下降。

4.4K50

IOR中文文档

文档由两部分组成。用户文档包括安装说明(Install),初学者教程(IOR的第一步),以及关于IOR的运行时选项的信息。...开发者文档包括用Doxygen生成的代码文档和一些关于与Travis的连续整合的说明。...IOR/mdtest用户和开发者文档的许多方面都是不完整的,我们鼓励贡献者 鼓励贡献者直接评论代码或在此基础上扩展文档。...源文档链接 https://buildmedia.readthedocs.org/media/pdf/ior/latest/ior.pdf 2.安装 如果顶层目录中缺少 "configure",你可能直接从版本库中检索了这段代码...本文档使用doxygen来解析c代码。因此,无论如何都会在后台创建一个doxygen实例。这可能是有帮助的,因为doxygen产生漂亮的调用图 9. CI 持续集成用于基本的理智性检查。

5.3K10
领券