Sun. Dec 22nd, 2024

TourismWiki General Blog

We want to talk about other topics

Realtime documentation solution by DocStell

3 min read

Workspace for your notes, tasks and projects from DocStell, 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 block 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 adding methods 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 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.

Builtin diagram editor lets you keep vital information up to date in a snap. Slack integration: Connect the workspace in Docstell with a channel in Slack to receive notifications when someone is commenting. Markdown: Builtin markdown editor lets you format your texts efficiently. Docstell uses Github-flavored Markdown (GFM) with our own modifications to how the headers are being presented in the Docstell workspace. Discover extra details on Organize your software processes.

Slack integration was recently added 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. 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.

How to avoid software documentation hell? The key to this is that it must be possible to hide information that is in the way to get the big picture but still be there to be found when it’s the details that you need. A good search function is vital of course, but it must not hinder you from seeing the information that might be adjacent to your search terms and crucial for your understanding. When everybody is on the same page you will notice that you can start to have fewer meetings and still be able to take better decisions.

A new and extremely simple way to document your software requirements, processes and specifications. Built as a zoomable infinite document for really great flexibility, powerful enough to let you define all your complex needs. No more excuses not having your documentation up to date! Discover more details on docstell.com.