Thoughts and Ideas

MkDocs - Step By Step
Tool & Resources Yvonne Beirne FitzGerald Tool & Resources Yvonne Beirne FitzGerald

MkDocs - Step By Step

MkDocs is an easy-to-use static HTML site generator that enables the creation of Project Documentation for end users quickly. In addition, it is easy to customize the project documentation and the look and feel of the site. I create a Bits & Bytes Quick Note To Self on how to set up and use MkDocs.

Read More
Project Design: Help Files Template
Tool & Resources Yvonne Beirne FitzGerald Tool & Resources Yvonne Beirne FitzGerald

Project Design: Help Files Template

Creating amazing user documentation for a Project is critical to the project's success. With good user documentation, a tool becomes easier to use, increases the chance of mass adaption and citation, reduces the support burden for the developer, creates raving fans, and increases the professional feel of the project. All these benefits can lead to increase funding and opportunities for the developers and happy users.

Read More