Article type: Fundamental
Article name: Axiome - Writeups
Author: Framez


Description:

One of the cornerstones of Listiary I have envisioned, as its creator, is the ability of users and contributors to dictate where the project is going, by consensus and voting. Which is not saying much, as most FOSS projects do this in some shape or form, using different mechanisms.

The main mechanisms in Listiary are write-ups that users submit. They can do this in a number of ways, but the most simple one would be to go to the documentation site and choose to submit a write-up.

Those can be a few different things, and we will have templates for them. The beauty of the doc site approach is that the user gets fields to fill, and is not dealing with templates.

That said, other channels are also valid, and those templates are just a suggestion - a user does not need to comply - but simply submit a text in a legible way.

Some common types of write-ups include:

Bug reports

Short descriptions of encountered bugs goal is to provide maximum data needed to reproduce the bug

Feature suggestions

Users write in short text an idea they are having about the project. Often good approach is to start with a problem > solution proposition > limitations / pitfalls goal is to provide maximum clarity

Remarcticles

Those are like a field journal for contributors Contributors describe what they were doing, how they think about topics concerning the project. First person narrative is common, some personal details might be added sparsely. goal is to share context behind write-ups and foster a shared culture, and familiarity

Few rules

Write ups should not be edited - they are raw artifacts of someone’s idea - typos and all, caffeinated inventor-goblin energy at 2AM, etc. If a clarification is needed, it should be added afterwards by an editor, but never altering the original write-up.

Write ups should not be rejected easily - even if there is a little perceived value in a suggestion, if it is not off topic or trolling, a write-up deserves to be included.

Write-ups can have attached files, but those should be small and non-executable



Back