Textpattern CMS support forum
You are not logged in. Register | Login | Help
- Topics: Active | Unanswered
[wiki] Plugin URIs in User Documentation
I noticed that (as of this writing) the keywords tag page contains a link to rah_metas.
My question is, which is the most appropriate target?
- The Official Plugin Page
- The Plugin Page at Textpattern Resources
- The Support Forum Thread
I would propose that whenever possible the documentation should link to official resource sites, rather than external content.
Offline
Re: [wiki] Plugin URIs in User Documentation
Additional question:
Should the tag reference link to specific plugins at all?
Offline
Re: [wiki] Plugin URIs in User Documentation
ruud wrote:
Should the tag reference link to specific plugins at all?
I can see the argument for not linking, but personally, I see these as potentially very useful.
Offline
Re: [wiki] Plugin URIs in User Documentation
Both good questions.
ruud wrote:
Should the tag reference link to specific plugins at all?
Personally, I think the answer is yes, if it’s done correctly. It’s about context: walking a person from out-of-box to advanced possibilities in a structured, direct way, rather then letting people flounder. It’s about facilitation, self-sufficiency, and lowering the slope of the learning curve. It’s about using smart documentation techniques, putting related content together.
The out-of-box documentation should not turn into plugin documentation, per se, but I don’t see any reason why you can’t introduce a few solid/quality/well-supported plugins at the end of pages in context to a particular topic. Some plugins fit better than others. That’s just the way it is. We want the plugins that fit really well; it’s not meant to incite ego contests, and I’d be disappointed if it was looked at in such a way, which isn’t putting the user first.
michaelkpate:
Which is the most appropriate target?
In my opinion, the most appropriate target is Textpattern CMS Plugins. That link should be changed, if it’s not correct. However, every time I visit that site, I immediately have the impression of something abandoned. I also have the impression many plugin authors don’t want to bother with .org. It really needs to move forward for a lot of reasons.
Whatever anybody can do to help Stef on that project, please do it.
Last edited by Destry (2011-08-15 23:33:33)
Offline
Re: [wiki] Plugin URIs in User Documentation
Destry wrote:
The out-of-box documentation should not turn into plugin documentation, per se, but I don’t see any reason why you can’t introduce a few solid/quality/well-supported plugins at the end of pages in context to a particular topic. Some plugins fit better than others. That’s just the way it is. We want the plugins that fit really well; it’s not meant to incite ego contests, and I’d be disappointed if it was looked at in such a way, which isn’t putting the user first.
I put in the plugins I thought were relevant but I may easily have missed some and made some improper choices. But since it is a wiki, it is easy enough to make corrections.
Offline