Textpattern CMS support forum
You are not logged in. Register | Login | Help
- Topics: Active | Unanswered
[wiki] Draft: TextBook Writing, Editing, and Collaboration Guidelines
TextBook needs the community’s help to draft a new set of working guidelines by which everyone can be at peace and understanding with what to write, and how to edit and collaborate. Usually people are quick to say what’s wrong or what they think doesn’t work, but rarely does anybody offer any constructive suggestions in return. If you don’t offer suggestions, your rants only go so far.
We’re looking for actual guideline suggestions here, as you would expect to see them written in a TextBook help page for the benefit of potential writers and editors. We want something that everybody is happy with, by the community for the community, but which also serves the interests of good, timely, authoritative documentation.
Likely we don’t want this to turn into a manifesto, but we should cover enough basic principles that address as many questions as possible that might be asked.
Let’s have it…what do you suggest?
Offline
Re: [wiki] Draft: TextBook Writing, Editing, and Collaboration Guidelines
I’ll just keep adding things here and try and organize as it goes along. People should contribute and/or comment as they see fit.
Basic (Common) Guidelines
- When proposing or creating a new page, please provide a page title that is concise and uses appropriate capitalization. This title will become the permanent title for the page, as well as any resulting links generated to it so it helps to get it right the first time. Good titling is not as easy as one would like to think (document semantics is the thing of PhD study) so if you’re not sure of a title, get some community feedback on it in the Document Discussion forum.
Translation Guidelines
- (translation guidelines already exist, but getting overlooked) — If you are providing translation assistance, please do not start a new page in your given language if there is not one already started in English first. Propose the page to Wiki admins/editors for inclusion in the English side first, and then translate the page as a mirror of the English page. Naturally, title your translated pages in your given language, not English.
Offline
Re: [wiki] Draft: TextBook Writing, Editing, and Collaboration Guidelines
We probably need to get all these things in sync with this effort, perhaps even filter it down to one or two final pages — information seems to have gotten spread out and hard to find; thus not being very useful:
- TextBook’s wiki How Do I…
- Wiki Help
- Translation Guidelines
- Community Portal
If anyone has suggestions about architecting this information a bit better, please, I’m all ears.
Offline