Markdown技术文档编写规范
Markdown技术文档编写规范 Markdown是一种可以使用普通文本编辑器编写的标记语言，通过简单的标记语法，它可以使普通文本内容具有一定的格式。 文档体系 结构 简介（Introduction）： [必备] [文件] 提供对产品和文档本身的总体的、扼要 ...
原文：中文技术文档写作规范
使用 markdown 格式书写文档 只使用一二三级标题，三级标题下面的并列性内容使用列表展示 二级标题前使用行分隔符表示分隔 段落之间使用一个空行隔开 一句话或者以逗号分隔的句子，长度尽量保持在 个字以内， 个字的句子，可以接受 禁止文字口语化 尽量使用肯定句表达，不使用否定句表达 例如：没有 不能 不可以 不使用 被 第一次出现英文词汇时，在括号中给出中文标注 例如：IOC Internat ...
2021-12-14 10:53 0 138 推荐指数：
相关推荐
Javassist中文技术文档
本文译自Getting Started with Javassist，如果谬误之处，还请指出。 bytecode读写 ClassPool Class loader 自 ...
学习一下阿里技术文档的写作方法
我觉得写的挺好的，如果让我写一个技术文档，我可能写的没有那么好，关键是学习一下写作结构，我相信只要大的框架对的话，就算语言水平差强人意，同一个圈子里面的人也能理解技术文档应该没有什么障碍的。 https://antv.alipay.com/g2/doc/index.html 这是阿里的一个 ...
美赛论文写作--写作规范
一、段落和句子 1.写作要使用简短的段落，但是要避免出现只含有一两个简单句子的超短段落，如果论文中含有很多这样的句子，就会使读者频繁停顿，影响阅读的连贯性。 2.写作时要尽可能的用简单句，越简单越好，一个句子仅需要表达一个意思。 3.要使用简单的单词和短语。例： 劣：Due ...
前端新技术中文文档
nodejs中文网，官网同步翻译 http://nodejs.cn/api/ Webpack 中文手册（社区同步翻译） http://6.course.uprogrammer.cn/webpack2-doc-cn/index.html ECMAScript6 中文教程 https ...
SQLAlchemy技术文档（中文版）（全）
原文链接：http://www.cnblogs.com/iwangzc/p/4112078.html（感谢作者的分享） sqlalchemy 官方文档：http://docs.sqlalchemy.org/en/latest/contents.html 1.版本检查 import ...
SQLAlchemy技术文档（中文版）（上）
在学习SQLAlchemy的过程中，好多时候需要查官方Tutorial，发现网上并没有完整的中文版，于是利用这两天空余时间粗略翻译了一下。 翻译效果很差。。。。但也算是强迫自己通读一遍Tutorial，收获很多。 1.版本检查 import sqlalchemy ...