# nxin-docs
**Repository Path**: 6296777/nxin-docs
## Basic Information
- **Project Name**: nxin-docs
- **Description**: 农信互联技术文档
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: develop
- **Homepage**: None
- **GVP Project**: No
## Statistics
- **Stars**: 0
- **Forks**: 0
- **Created**: 2017-02-23
- **Last Updated**: 2023-09-04
## Categories & Tags
**Categories**: Uncategorized
**Tags**: None
## README
# 农信互联-技术文档项目
本项目是为了解决目前项目开发文档零散不统一的问题，这导致技术人员需要耗费更多时间和精力去寻找并理解当前的技术架构，以及其对应的业务文档。
我们准备将分散的文档进行归纳整理，并以统一入口，统一的格式（Markdown），统一的风格(主流开源技术文档风格)进行整理，方便所有技术人员搜索查阅。意义在于，未来所有的文档均会汇总在一个入口，不需要再单独四处零散存放，寻找，这里有的就有，没有的就没有，并且所有文档格式一致，风格一致，减少歧义，节省技术人员阅读文档的时间。
# 技术文档目录
## [企联网-业务描述文档](http://git.oschina.net/6296777/nxin-docs/blob/master/企联网-业务描述文档.md)
本文档描述了企联网的背景、业务需求、整体结构，PM及架构师必读~！
## [企联网-技术开发文档](http://git.oschina.net/6296777/nxin-docs/blob/master/企联网-开发文档.md)
本文档描述了企联网当前的整体技术开发情况，包括系统架构、代码结构、环境配置、代码发布、测试环境、线上部署等，程序员必读~！
## [新手快速上手指南](http://)
本文档描述了新人加入项目后，如何快速配置开发环境、配置数据库、以及发布代码，快速上手必读~！
## [开发者规范](http://git.oschina.net/6296777/nxin-docs/blob/master/开发者规范.md)
本文档描述了开发中的必要规范及默认约定，必读~！
## [开发计划](http://)
## Markdown 简介
Markdown 是一种轻量级的「标记语言」，它的优点很多，目前也被越来越多的写作爱好者，撰稿者广泛使用。看到这里请不要被「标记」、「语言」所迷惑，Markdown 的语法十分简单。常用的标记符号也不超过十个，这种相对于更为复杂的HTML 标记语言来说，Markdown 可谓是十分轻量的，学习成本也不需要太多，且一旦熟悉这种语法规则，会有一劳永逸的效果。...
它用简洁的语法代替排版，而不像一般我们用的字处理软件 Word 或 Pages 有大量的排版、字体设置。它使我们专心于码字，用「标记」语法，来代替常见的排版格式。例如此文从内容到格式，甚至插图，键盘就可以通通搞定了。目前来看，支持 Markdown 语法的编辑器有很多，包括很多网站（例如简书）也支持了 Markdown 的文字录入。Markdown 从写作到完成，导出格式随心所欲，你可以导出 HTML 格式的文件用来网站发布，也可以十分方便的导出 PDF 格式，这种格式写出的简历更能得到 HR 的好感。甚至可以利用 CloudApp 这种云服务工具直接上传至网页用来分享你的文章，全球最大的轻博客平台 Tumblr，也支持使用 Mou 这类 Markdown 工具进行编辑并直接上传。
### 使用 Markdown 的优点
1.专注你的文字内容而不是排版样式。
2.轻松的导出 HTML、PDF 和本身的 .md 文件。
3.纯文本内容，兼容所有的文本编辑器与字处理软件。
4.可读，直观。适合所有人的写作语言。
### 相关语法资料：
1. Markdown ： http://daringfireball.net/projects/markdown/syntax/
2. Markdown中文: http://wowubuntu.com/markdown/#list/
3. Markdown Plus ： https://github.com/tylingsoft/markdown-plus/
4. 我整理的快速学习 : [Markdown语法示例](http://git.oschina.net/6296777/nxin-docs/blob/master/Markdown.md)
**更新记录位于 [CHANGELOG.md](https://master/CHANGELOG.md?dir=0&filepath=CHANGELOG.md)**