我需要在文档中涵盖哪些内容？

Question

我正在为我编写的一个小型ActionScript 3库编写自己的文档。

我尽可能地保持尽可能接近Adobe Livedocs的布局和内容，同时清理一下。

我想我已经涵盖了人们在阅读我的文档时想要了解的所有内容，但在开始添加我创建的所有类之前，我不想错过任何重要的内容。

你有什么想要的文件吗？大多数文档中是否存在您认为不必要的内容？

这是我到目前为止所得到的：https://projectavian.com/docs/zephyr/#/entity

我试图报道的一些事情是：

1. 轻松直接链接到文档部分。即/#/class.propertyOrMethod如上所述。
2. 页面顶部的整洁表格简要列出了每个属性，方法，常量或类中其他任何相关的主食。
3. 在步骤1中，可以直接通过URL导航到的每个属性或方法的明确分隔的信息块。单击页面顶部表格中的相关文本也将链接到此处。
4. 方法参数的整洁布局，每个都有简洁的解释。

Answer 1

我非常喜欢文档的设计。当我第一次做某事时，我想参考其他相关工作，以确保我涵盖所有相同的基础。那就是说，我认为你已经覆盖了他们。

我知道的一些记录良好的AS类：

TweenMax @ http://www.greensock.com/as/docs/tween/com/greensock/TweenMax.html BulkLoader @ http://media.stimuli.com.br/projects/bulk-loader/docs/ CASA Lib @ http://as3.casalib.org/docs/

您可以浏览它们以获取灵感/深入了解高度精炼的Action Script类文档。每个版本都经过多个版本的发布，经得起时间的考验。