Interesting Things Blog Software A modern and very effective way to document your software specifications

A modern and very effective way to document your software specifications

Online documents and projects organizer from Docstell.com, a new online software solution for organizing software processes. This days software programming has become an extremly complicated thing to organize. Let’s start with the basics: The markdown method in Docstell is very convenient to use. When a text zone is added to a node you can begin typing your markdown right away. When leaving the edit area the text is automatically formatted. The idea with markdown is that it will save you a lot of time when formatting your texts. Markdown allows you to write using an easy-to-read, easy-to-write plain text format, which is then converted to valid HTML. Instead of getting frustrated about how a lot of common word processors format your text in every way but the one you want, markdown is very predictable and easy to learn.

Docstell is also implementing functions to upload documents to a node. You can upload any kind of file and share with you team or keep it in a private node. Just drag it from you computer and drop it on the node you want to attach it to. They added a preview zone that makes it possible to preview files adjacent to your other information. You can view for example pdf, docx, xlsx, csv, txt, png, jpeg and mpeg4 files. If you for example receive a specification in a pdf file format you keep this file here together with the rest of the documentation and will easily be able to preview it and let all your team have access to it.

Super simple way to organise your information and keeping it structured and quickly accessible. All nodes has its own address which mean that it is easy to direct people for feedback or hide information not in scope. Drill in to the documentation to put focus on the right content. Really fast navigation back and forth throughout the information. Reorganise with drag and drop. If you are used to Workflowy you will instantly understand how Docstell is working. Docstell adds a different kind of tools to each node but the principle of nodes that can be indented, collapsed and drilled into is the same. Find additional details at Document organizer with diagram editor.

Slack integration was recently added to Docstell. This lets you get alerted in your designed Slack channel when a person in your team is commenting your documentation. From the message in Slack you get a link back to the node with the comment in Docstell, this makes it convenient to answer the question in the right context and to build up the knowledge base where it should be. There will also be a number in the browser tab indicating the number of unresolved comments where you are mentioned. The background color of the comments icon is also changed to yellow. When clicking the comments icon you see the comments pane where it is possible to use the filter to see only the ones where you are mentioned.

There is of course a fine balance of what kind of information you should put in a document or not write down at all. It costs money to keep the information up to date where ever it might be placed. But that is not a reason for not putting all your information in one place. Having it in one place will make it a lot easier to keep it updated and keep it concise and coherent. To always have the exactly right information at your fingertips whenever you need it might be a utopian, but I am sure that there are a lot of things that can be made to improve this area immensely.

Go simple, make it efficient and start to benefit from the power of having your documentation organised and accessible for your whole team. All the time. Keeping software documentation simple and super easy to update will prevent your team to invent new ways of adding specs in new formats and put it in places where it is hard to find. Read more info at https://docstell.com/.