Documentation 我需要在文档中包含哪些内容？

我正在为自己编写的一个小ActionScript3库编写自己的文档

我试图尽可能地接近AdobeLiveDocs的布局和内容，同时稍微清理一下

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

有什么东西是你想要的吗？在大多数文档中有没有你认为不重要的东西？

以下是到目前为止我得到的信息：

我试图讲述的一些事情是：

轻松直接链接到文档部分。ie

/#/class.propertyOrMethod

如上所述

页面顶部的整洁表格简要列出了类中存在的每个属性、方法、常量或任何其他相关主食

与每个属性或方法相关的清晰分离的信息块，可以在步骤1中通过URL直接导航到这些信息块。单击页面顶部表格中的相关文本也将链接到此处

整洁的方法参数布局，每个参数都有简明的解释

---

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

我知道一些有很好文档记录的类：

吐温马克斯@ 散货装载机@ 卡萨图书馆@

---

您可以浏览它们，从中获得对高度精炼的动作脚本类文档的灵感/见解。每个版本都经过了多个版本的发布，并且经受住了时间的考验。

casalib.org的文档非常好，感谢您的链接。