Skip to content

proposed: Collaboration on user documentation #149

Open
@wion

Description

@wion

URLs:

back: https://github.com/textpattern/textpattern.github.io/blob/master/brand/user-docs-collaboration.md
front: https://docs.textpattern.com/brand/user-docs-collaboration

Scenario

A doc for recording collaboration procedures, and reference thereafter. This is a new issue for the effort. This is not the same thing as the docs authoring/editing guidelines, which concerns content development.

Resources for consideration

  1. researching docs collaboration procedures #116
  2. Collaboration guidelines test run
  3. Images in docs
  4. File naming convention
  5. Redirecting
  6. Txp github teams

To-dos

Some reflection on the above resources might be needed.

  • A workflow diagram to help visualize doc development from ideation to publication.
  • A 'Get help' section at end. (Where should the help link point to? Should we talk about roles here, as might be reflected in item 6 above?)
  • A section addressing use of images? (Using images is a lot of tedious work, let's remember, see item3 above. This section would be small, though, because how to actually use images would be fodder in the development guidelines.)
  • Revise Issues templates to change checkbox lists in the 'Resources...' section to just bulleted lists, and update doc to suggest checkbox lists are useful after issues are created to list sub-tasks for main tasks (as doing here).
  • Work in any relevant bits from item 2 above.
  • Work in any relevant bits from item 4 above.
  • Ensure item 5 above is sufficiently outlined.

Metadata

Metadata

Assignees

No one assigned

    Labels

    editingDocument editing/revising in progress; others do not touch.

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions