基于asciidoc的产品文档大纲规划-中文版本_asciidoctor中文,asciidocfx资源-CSDN下载

共27个文件

adoc：17个

png：7个

docx：1个

需积分: 50 96 浏览量 2019-03-18 20:21:36 上传评论收藏 1.68MB ZIP 举报

**基于Asciidoctor的产品文档大纲规划** 在技术文档领域，Asciidoctor是一种流行的标记语言，用于创建结构化和可读性强的文档。它基于ASCII文本格式，支持Markdown语法，但提供了更丰富的功能和扩展性。对于中文文档，特别需要注意的是编码问题，因为不正确的编码设置可能会导致乱码。在“基于asciidoc的产品文档大纲规划”中，我们首先要理解Asciidoctor的基本概念。Asciidoctor允许我们用简单的文本格式编写文档，然后转换成各种格式，如HTML、PDF或EPUB。其优点在于保持了源代码的简洁性和可读性，同时也方便版本控制和团队协作。文档大纲是规划和组织内容的关键部分。一个清晰的大纲有助于读者快速理解文档结构，并找到所需信息。在Asciidoctor中，我们可以通过标题来定义大纲级别。例如： ```asciidoc = 产品手册 == 用户指南 === 安装与设置 ==== 快速启动 ===== Windows ===== macOS ===== Linux === 使用教程 ==== 功能介绍 ==== 操作步骤 ``` 在这个例子中，"产品手册"是顶级标题，"用户指南"是二级标题，"安装与设置"和"使用教程"是三级标题，而"快速启动"、"Windows"、"macOS"、"Linux"、"功能介绍"和"操作步骤"则是四级标题。通过这种方式，我们可以构建一个层次分明的文档结构。在处理中文文档时，需要确保Asciidoctor支持UTF-8编码。在AsciidoctorFX编辑器中，创建或打开文件时，要检查文件的编码设置。如果直接修改AsciidoctorFX自带的英文示例，可能会遇到乱码问题，这是因为默认配置可能不适用于中文字符。解决这个问题的方法是在文件头部添加以下行： ```asciidoc [subs="attributes"] :encoding: utf-8 ``` 这将指定文档的编码为UTF-8，避免乱码的出现。压缩包中的“01_userguide”可能表示用户指南的初始章节。这个文件应包含关于产品使用的基本信息，如安装步骤、功能介绍、操作指南等。按照Asciidoctor的规则，这个文件应该包含上述提及的大纲结构，用相应的标题来划分各个部分。在实际应用中，我们还应考虑其他Asciidoctor特性，如自定义样式、内联和块级宏、表格、图像、链接和引用等，以增强文档的表达力。同时，可以利用Asciidoctor的扩展机制，如通过Ruby插件添加自定义行为，以满足特定的文档需求。基于Asciidoctor的产品文档大纲规划是一项涉及文本编码、文档结构和内容组织的任务。通过合理使用Asciidoctor的特性和工具，我们可以创建出专业且易于阅读的中文技术文档，为用户提供清晰的指引。

资源推荐

资源详情

资源评论

收起资源包目录

基于asciidoc的产品文档大纲规划-中文版本.zip （27个子文件）

01_userguide

03_sub5_automl.adoc 412B

06_customer_service.adoc 576B

dedication.adoc 13B

03_operation_guide.adoc 257B

image

DataCanvas.jpg 717KB

04_selfdefine_module.png 58KB

07_online_prediction.png 29KB

02_data_source.png 149KB

05-workflow.png 79KB

06-automl.png 109KB

01_system_architecture.png 172KB

03_data_explore.png 37KB

05_faq.adoc 226B

00_preface.adoc 707B

04_best_practices.adoc 1KB

03_sub4_workflow.adoc 313B

02_quick_start.adoc 1KB

03_sub1_project.adoc 859B

03_sub2_dataset.adoc 2KB

action.adoc 44B

index.adoc 916B

03_sub7_system.adoc 5KB

03_sub3_module.adoc 749B

01_introduction.adoc 4KB

index.html 76KB

03_sub6_service.adoc 870B

APS 产品文档大纲规划.docx 875KB

<!DOCTYPE html> <html lang="en"> <head> <meta charset="UTF-8">  <meta name="viewport" content="width=device-width, initial-scale=1.0"> <meta name="generator" content="Asciidoctor 1.5.5.dev"> <meta name="keywords" content="DataCanvas, APS, Meachine Learning, Deep Learning"> <meta name="author" content="Zetyun. Co. Ltd."> <title>DataCanvas APS 产品文档</title> <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Open+Sans:300,300italic,400,400italic,600,600italic%7CNoto+Serif:400,400italic,700,700italic%7CDroid+Sans+Mono:400,700"> <style> /* Asciidoctor default stylesheet | MIT License | http://asciidoctor.org */ /* Remove comment around @import statement below when using as a custom stylesheet */ /*@import "https://fonts.googleapis.com/css?family=Open+Sans:300,300italic,400,400italic,600,600italic%7CNoto+Serif:400,400italic,700,700italic%7CDroid+Sans+Mono:400,700";*/ article,aside,details,figcaption,figure,footer,header,hgroup,main,nav,section,summary{display:block} audio,canvas,video{display:inline-block} audio:not([controls]){display:none;height:0} [hidden],template{display:none} script{display:none!important} html{font-family:sans-serif;-ms-text-size-adjust:100%;-webkit-text-size-adjust:100%} body{margin:0} a{background:transparent} a:focus{outline:thin dotted} a:active,a:hover{outline:0} h1{font-size:2em;margin:.67em 0} abbr[title]{border-bottom:1px dotted} b,strong{font-weight:bold} dfn{font-style:italic} hr{-moz-box-sizing:content-box;box-sizing:content-box;height:0} mark{background:#ff0;color:#000} code,kbd,pre,samp{font-family:monospace;font-size:1em} pre{white-space:pre-wrap} q{quotes:"\201C" "\201D" "\2018" "\2019"} small{font-size:80%} sub,sup{font-size:75%;line-height:0;position:relative;vertical-align:baseline} sup{top:-.5em} sub{bottom:-.25em} img{border:0} svg:not(:root){overflow:hidden} figure{margin:0} fieldset{border:1px solid silver;margin:0 2px;padding:.35em .625em .75em} legend{border:0;padding:0} button,input,select,textarea{font-family:inherit;font-size:100%;margin:0} button,input{line-height:normal} button,select{text-transform:none} button,html input[type="button"],input[type="reset"],input[type="submit"]{-webkit-appearance:button;cursor:pointer} button[disabled],html input[disabled]{cursor:default} input[type="checkbox"],input[type="radio"]{box-sizing:border-box;padding:0} input[type="search"]{-webkit-appearance:textfield;-moz-box-sizing:content-box;-webkit-box-sizing:content-box;box-sizing:content-box} input[type="search"]::-webkit-search-cancel-button,input[type="search"]::-webkit-search-decoration{-webkit-appearance:none} button::-moz-focus-inner,input::-moz-focus-inner{border:0;padding:0} textarea{overflow:auto;vertical-align:top} table{border-collapse:collapse;border-spacing:0} *,*:before,*:after{-moz-box-sizing:border-box;-webkit-box-sizing:border-box;box-sizing:border-box} html,body{font-size:100%} body{background:#fff;color:rgba(0,0,0,.8);padding:0;margin:0;font-family:"Noto Serif","DejaVu Serif",serif;font-weight:400;font-style:normal;line-height:1;position:relative;cursor:auto} a:hover{cursor:pointer} img,object,embed{max-width:100%;height:auto} object,embed{height:100%} img{-ms-interpolation-mode:bicubic} .left{float:left!important} .right{float:right!important} .text-left{text-align:left!important} .text-right{text-align:right!important} .text-center{text-align:center!important} .text-justify{text-align:justify!important} .hide{display:none} body{-webkit-font-smoothing:antialiased} img,object,svg{display:inline-block;vertical-align:middle} textarea{height:auto;min-height:50px} select{width:100%} .center{margin-left:auto;margin-right:auto} .spread{width:100%} p.lead,.paragraph.lead>p,#preamble>.sectionbody>.paragraph:first-of-type p{font-size:1.21875em;line-height:1.6} .subheader,.admonitionblock td.content>.title,.audioblock>.title,.exampleblock>.title,.imageblock>.title,.listingblock>.title,.literalblock>.title,.stemblock>.title,.openblock>.title,.paragraph>.title,.quoteblock>.title,table.tableblock>.title,.verseblock>.title,.videoblock>.title,.dlist>.title,.olist>.title,.ulist>.title,.qlist>.title,.hdlist>.title{line-height:1.45;color:#7a2518;font-weight:400;margin-top:0;margin-bottom:.25em} div,dl,dt,dd,ul,ol,li,h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6,pre,form,p,blockquote,th,td{margin:0;padding:0;direction:ltr} a{color:#2156a5;text-decoration:underline;line-height:inherit} a:hover,a:focus{color:#1d4b8f} a img{border:none} p{font-family:inherit;font-weight:400;font-size:1em;line-height:1.6;margin-bottom:1.25em;text-rendering:optimizeLegibility} p aside{font-size:.875em;line-height:1.35;font-style:italic} h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{font-family:"Open Sans","DejaVu Sans",sans-serif;font-weight:300;font-style:normal;color:#ba3925;text-rendering:optimizeLegibility;margin-top:1em;margin-bottom:.5em;line-height:1.0125em} h1 small,h2 small,h3 small,#toctitle small,.sidebarblock>.content>.title small,h4 small,h5 small,h6 small{font-size:60%;color:#e99b8f;line-height:0} h1{font-size:2.125em} h2{font-size:1.6875em} h3,#toctitle,.sidebarblock>.content>.title{font-size:1.375em} h4,h5{font-size:1.125em} h6{font-size:1em} hr{border:solid #ddddd8;border-width:1px 0 0;clear:both;margin:1.25em 0 1.1875em;height:0} em,i{font-style:italic;line-height:inherit} strong,b{font-weight:bold;line-height:inherit} small{font-size:60%;line-height:inherit} code{font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;font-weight:400;color:rgba(0,0,0,.9)} ul,ol,dl{font-size:1em;line-height:1.6;margin-bottom:1.25em;list-style-position:outside;font-family:inherit} ul,ol,ul.no-bullet,ol.no-bullet{margin-left:1.5em} ul li ul,ul li ol{margin-left:1.25em;margin-bottom:0;font-size:1em} ul.square li ul,ul.circle li ul,ul.disc li ul{list-style:inherit} ul.square{list-style-type:square} ul.circle{list-style-type:circle} ul.disc{list-style-type:disc} ul.no-bullet{list-style:none} ol li ul,ol li ol{margin-left:1.25em;margin-bottom:0} dl dt{margin-bottom:.3125em;font-weight:bold} dl dd{margin-bottom:1.25em} abbr,acronym{text-transform:uppercase;font-size:90%;color:rgba(0,0,0,.8);border-bottom:1px dotted #ddd;cursor:help} abbr{text-transform:none} blockquote{margin:0 0 1.25em;padding:.5625em 1.25em 0 1.1875em;border-left:1px solid #ddd} blockquote cite{display:block;font-size:.9375em;color:rgba(0,0,0,.6)} blockquote cite:before{content:"\2014 \0020"} blockquote cite a,blockquote cite a:visited{color:rgba(0,0,0,.6)} blockquote,blockquote p{line-height:1.6;color:rgba(0,0,0,.85)} @media only screen and (min-width:768px){h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{line-height:1.2} h1{font-size:2.75em} h2{font-size:2.3125em} h3,#toctitle,.sidebarblock>.content>.title{font-size:1.6875em} h4{font-size:1.4375em}} table{background:#fff;margin-bottom:1.25em;border:solid 1px #dedede} table thead,table tfoot{background:#f7f8f7;font-weight:bold} table thead tr th,table thead tr td,table tfoot tr th,table tfoot tr td{padding:.5em .625em .625em;font-size:inherit;color:rgba(0,0,0,.8);text-align:left} table tr th,table tr td{padding:.5625em .625em;font-size:inherit;color:rgba(0,0,0,.8)} table tr.even,table tr.alt,table tr:nth-of-type(even){background:#f8f8f7} table thead tr th,table tfoot tr th,table tbody tr td,table tr td,table tfoot tr td{display:table-cell;line-height:1.6} body{tab-size:4} h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{line-height:1.2;word-spacing:-.05em} h1 strong,h2 strong,h3 strong,#toctitle strong,.sidebarblock>.content>.title strong,h4 strong,h5 strong,h6 strong{font-weight:400} .clearfix:before,.clearfix:after,.float-group:before,.float-group:after{content:" ";display:table} .clearfix:after,.float-group:after{clear:both} *:not(pre)>code{font-size:.9375em;font-style:normal!important;letter-spacing:0;padding:.1em .5ex;word-spacing:-.15em;background-color:#f7f7f8;-webkit-border-

评论收藏

内容反馈