I came across a very handy tool for writing quick and simple documentation – Documenter v2.
It provides a quick and simple web interface to handle document meta information (titles, subtitles, author, created and updated dates, etc), sections, styles, extra buttons, and more. You can also download and save the results, as well as continue where you left off later.
More and more paper work is moving into the digital domain, including legal documents. I’ve previously linked to Docracy – a service that provides a collection of legal documents, as well as tools to negotiate and sign them. Today I was made aware of another service – FormSwift. Some might find it to be more comprehensive, up-to-date and user friendly than the alternatives.
Have a look at the FormSwift’s collection of the free legal forms, which cover such categories as business, family, financial, life planning, real estate and other. Their tools are pretty sweet too, with support for Word and PDF files, and an online editor for PDF – not something you see every day.
I’ve mentioned Graphviz many a time on this blog. It’s simple to use, yet very powerful. The dot language is something that can be jotted down by hand in the simplest of all text editors, or generated programmatically.
The official website features a gallery, which demonstrates a wide range of graphs. But I still wanted to blog a few examples from my recent use.
Continue reading “Using Graphviz dot for ERDs, network diagrams and more”
It’s after bits like this one, I think I should spend more time reading documentation:
Create a new transaction.
This routine should _never_ be called by anything other than RT::Ticket. It should not be called from client code. Ever. Not ever. If you do this, we will hunt you down and break your kneecaps. Then the unpleasant stuff will start.
TODO: Document what gets passed to this
RT::Transaction->Create() developer manual for Request Tracker 4.2.
SchemaSpy – Graphical Database Schema Metadata Browser. This is a tool written in Java that helps one to generate database schema documentation. Have a look at some sample pages. Those familiar with Graphviz will immediately realize that the tools is using dot for graphing tables and their relationships. Those familiar with SugarCRM documentation will immediately notice that SchemaSpy is used for the API documentation.
Docracy – free legal documents, or as they describe it on their website:
the web’s only open collection of legal contracts and the best way to negotiate and sign documents online
Very handy for things likes contracts, proposals, and non-disclosure agreements (NDAs).
DevDocs.io – a local cache of searchable documentation
I’ve heard about this project for a while now, but tried it only today. This blog post left me no options. And I’m glad. Because DevDocs are absolutely awesome!
Here is a handy list manuals for the systemd:
Via this Slashdot comment.
Read the Docs – create, host, and browse documentation
Read the Docs hosts documentation, making it fully searchable and easy to find. You can import your docs using any major version control system, including Mercurial, Git, Subversion, and Bazaar. We support webhooks so your docs get built when you commit code. There’s also support for versioning so you can build docs from tags and branches of your code in your repository.