文档的工作流程和最佳实践

时间:2011-09-06 作者:jnolte

我们已经创建了一系列非常定制的模板,并且会不时更改,但从主题到主题也有一系列类似的部分。我希望简化我们创建文档的方式,以传递给用户,并希望WPA社区了解他们用于创建文档的内容。我正在考虑创建某种类型的Wiki,以便在进行过程中将其传递给客户,但我还不完全清楚如何做到这一点。

有人能分享他们的经历、试炼和磨难吗?

提前感谢!

JN公司

1 个回复
SO网友:Rarst

问得好。WordPress圈子中没有通用和全面的文档工作流。然而,有一些很好的工具和选项可以使用。

自述。txt

基于减价的机器可读文件。它的主要目的是由官方插件库解析和呈现,但除此之外,它并不太方便。

这是一个很好的地方,适合进行初步概述,但对于高级说明来说就不太合适了。

上下文帮助管理面板中的上下文帮助最近(相对而言)开始变得有用。提供UI说明、本地和远程资源链接以及简短常见问题解答的绝佳位置。

主要问题是,作为一种新的、未被充分利用的东西,用户可能不会在那里寻找信息。简单的解决方法是有条件地触发它的打开-例如在第一次或直到用户执行所需的操作(设置配置等)。

PHPDoc内联文档对于开发人员来说是必不可少的。便于学习或维护代码。在IDE中非常有用。

一个不太明显的方面是,通过一些努力,内联文档可以用作生成更人性化文档的源。典型的例子是交叉引用,但有许多不太常见的可能性可以像generating wiki pages (无耻插头)。

除了WP和PHP提供的工具之外,根据您和您的客户的需要,您还可以做很多其他事情。

使用的典型out-of-WP解决方案是Wiki(或只有文档的站点)、问题跟踪程序、托管社区支持服务等。

此外,还对在WP本身中混合大量文档进行了一些探索。在最简单的情况下,这可以只包括富自述。带有插件的html。但也有更复杂的可能性,比如using of custom post types for docs.

结束

相关推荐

将目录路径传递给plugins_url()安全吗?

plugins_url() 函数接受插件slug或文件路径来构建URL。我有以下目录结构:/wp-content/mu-plugins/someplugin/css/file.css /wp-content/mu-plugins/someplugin/includes/file.php 我需要建立URL到file.css 在里面file.php. 我不能通过__FILE__ 因为这将是一个层次太深。plugins_url(\'css/file.css\', __FILE__ )