HEAVY META AHEAD
The following material is highly abstract. It relates to conceptualizing how the LiquiDoc/LDCMF User Guides repository can be adapted to suit your product and documentation environments. This topic should be excluded from or heavily edited for any instance of LiquiDoc Docs Project that is modified to cover a different product.

More than likely, the documentation you are reading now started life in the liquidoc-docs repo for which it was originally created. Every other file in this set is primarily oriented toward instructing the use and development of LiquiDoc’s own instance of LiquiDoc and LDCMF.

But each and every file in the original repository is also written with your product environment in mind. That is, with relatively minor editing, these documents about how to use, administer, and hack a LiquiDoc instance can be reoriented to serve as the canonical documentation for your entire product. These docs do not just cover your documentation environment, tooling, and workflow, but also your product-development environment, tooling, and workflow. Furthermore, this one repository can document your product itself, which is probably what you were looking for when you found it.

So to put it differently, LiquiDoc CMF is much more than a powerful solution for documenting your amazing software product no matter your development language or environment. The files in this LiquiDoc/LDCMF User Guides repository also happen to be a customizable set of instructions for how to use your actual LDCMF instance. And as long as it’s teaching your developers tech writers how to contribute code and docs, your modified version of these docs can be extended to serve as policy, workflow, and style guides for the entire product team!

Tags: