Jim's Articles

A modern and extremely simple way to document your software requirements

A modern and extremely simple way to document your software specifications, a new online software solution for organizing software specifications. In 2020 software programming has become an extremly complicated thing to organize. Let’s start with the basics: The markdown system in Docstell is very simple to use. When a text zone is inserted in to a node you can start 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 functionality to upload various file types 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 area 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. Discover more details on Software Project Organizer Solution.

Slack integration was recently implemented to Docstell. This lets you get notified in you preferred Slack channel when someone in your team is commenting your docs. 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. If you don’t use Slack or want to be notified by email we added functionality to mention a user in the comment. Use the @ sign to get a list of users that belongs to the workspace. If this user is not online an email is sent that tells the user that there is a message waiting to be answered. You can configure if emails should be sent in the new user settings dialog.

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.

Docstell lets you focus on the right thing, hiding for the moment irrelative information. Real time documentation, always up to date with the latest information accessible to your whole team. Discover extra details on https://docstell.com/.