Open Collective's namespaces

Analyzing Open Collective's namespaces

Current state

Here are the current namespaces of all main sections of Open Collective's documentation:

├── Welcome
├── About
├── The Open Collective Way
├── Product 
├── Collectives 
├── Backers & Sponsors
├── Expenses & Getting Paid
├── Fiscal Hosts
├── Developers
├── Internal
├── Projects
├── Design
├── Translators

Issues

  • Sections such as Design, Developers and Translators are trying to convey the same type of information (contribution guidelines), but have different naming schemes (persona vs. subject).

  • No consistency in namespaces.

  • The order in which each section is presented doesn't follow a thematic logic (It goes from Backers & Sponsors to Expenses & Getting Paid to Fiscal Hosts and Developers, then Internal to Projects, returning to Design and Translators).

  • Documentation about a few personas is hidden (Core contributors is under The Open Collective Way).

  • Conflicting documentation domains are put together (internal documentation under Internal and all end user documentation).

Solutions

  • Design, Developers and Translators should be merged into a single section (Contribute?).

  • The Welcome page should become a hub to point readers to the most relevant information for them. About should encapsulate all information about Open Collective as an organization and as a platform (rename to About us?). Every persona should have their own section.

  • Internaland Projects should not be mixed with end user documentation. Maybe we should import it to another space?

Proposal: new namespace scheme

├── Subject or persona (Contribution guidelines, Contributing)
│  └── Subject or action (Translation, Translating Open Collective)
│  │  └── Subject or action (Using Crowdin)
│  │  └── Type (FAQ)

Last updated