Sunday, 17 November, 2024

A new and very simple way to document your software requirements


Online documents and projects organizer from Docstell.com, a new online software solution for organizing software requirements. This days software programming has become an extremly complicated thing to organize. Let’s start with the basics: The markdown system in Docstell is really simple 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 adding 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. See additional info on Software Project Organizer Solution.

Slack integration was recently added to Docstell. This lets you get alerted in your favorite Slack channel when a person 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. 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.

Good developers and architects know how important it is to have good and up to date specifications of their systems, yet too many fail to accomplish this. Why is that? Well, I think it is too hard to get it right, or maybe we should say, it is not without friction. If it would have been easy then every project would have it in perfect order already. And we all know that is not the case. This sounds so easy, doesn’t it? Well, it is not! It is crucial that it is possible to easily grasp the documentation and to always easily find the correct place to put any new information. Only then will this be possible to achieve.

Do you find yourself chasing the right information in a plethora of different products and services? Write documentation and stay productive using built in diagram editor, markdown and simple spreadsheets in one tool. Discover additional details at docstell.com.

Categories

Archives

January 2020
M T W T F S S
« Dec   Feb »
 12345
6789101112
13141516171819
20212223242526
2728293031