Textpattern CMS support forum
You are not logged in. Register | Login | Help
- Topics: Active | Unanswered
[wiki] Hunt, Gather and Associate Txp Intelligence with Relevant Tag Pages
This thread on Category Archives is a perfect example of the kind of documentation that’s currently missing in TextBook. In this case, thorough explanation of categories; their default limitations and behavior in every scenario, in addition to how they do function.
I realize developing documentation content is always a matter of time and/or initiation, but I have a stepwise suggestion, and it’s easy to consider in terms of the Tag Reference pages…
Maybe it would be a good idea to add a new section (head it as Related Solutions) at bottom of each Tag Reference page that simply linked to external resources (like the thread noted above) that covered a related point but which are dreadfully missing in the examples of a given Tag page. If a given resource applied to multiple tags, then you would simply add the link to each relevant Tag’s page (more roads to the steak house, as it were).
This hunt/gather/associate process would be a huge, helpful step, making what is already a time/effort consuming process (writing docs) a little easier over time, and over time people might then follow up with those links and rewrite the intelligence into concise examples in context to a give Tag page.
Also, I think it would be perfectly relevant to add external links to non-core solutions for a problem. Again, using the thread example linked above, the suggestion is to use gbp_permanent_links. If a plugin is the only way to achieve a desired (and popular) solution to a structural problem, then those links should indeed be handy in the Tag pages relevant to the structural solution. In this case you might not actually write a Tag example, but the reference to the plugin should at least be in the Related Solutions section. (I can imagine that later when/if textpattern.org is redeveloped, there would be a process for adding custom plugin docs there that could then be linked back to the respective Tag Reference pages.)
Just some thoughts.
Offline