4/16/2023 0 Comments Sqlite documentationThe makefile contains the commands you want to run in the order you want to run them. The make system reads a makefile within your project folder. The make system, for me, is an easy way to group a collection of commands to together. If your more familiar with using bash scripts, or on Windows batch files, then use those. I use GNU Make to run the commands I need. If I add a new document type to the health exchange, I will add the entry to the CSV file and then run make load to load the data into SQLite for further processing. If I need to change an entry, I change it within the CSV file and then re-process the data. I maintain the list in a simple comma-separated (CSV) data file, like: Discharge Letter,823701000000103,SNOMED-CTĭrug/substance use,1064501000000103,SNOMED-CTĮnd of Life Care Document,861411000000103,SNOMED-CT The data set contains three fields: document name, clinical code, and schema. The data set I maintain is a list of medical document types used in a regional Health Information Exchange. ![]() Using a source code version system, like Git GNU Make, allows you to track the history of changes made to your documentation data. Leveraging the power of the SQL syntax, you can also control the ordering of the data and the splitting of the large results across multiple pages.Īlso, as the whole process is scripted, in my case using make, the commands that generate the documentation can be managed using source code control. Most documentation build process can include these external files ensuring the latest data is presented within the document. The ability to chain SQLite commands together makes the process flexible and repeatable.Īlso, the output from these commands can be piped into external files. This command, sqlite3, makes it easy to script the steps in your document creation process. SQLite uses a single terminal command to access all its features. Rather than attempting to maintain the two documents separately and potentially getting them out of synchronisation, I decided to use SQLite to hold a central copy of the data and use SQL (Structured Query Language) queries to produce the documentation formatting codes required. Having an automated process for generating the documents from the data is crucial. The data set grows and evolves as the project responds to new use cases. The first is a list of publishing standards, and the second is a role-based access control matrix. The documents display the same data in different ways depending on the intended audience of the document. I maintain several documents for a large health project. ![]() In this article I explain the benefits and demonstrate how to use SQLite to generate documentation. Or use it to manage software configuration files? Why would you want to use SQLite to maintain documentation? ↑ SQLite as a documentation creation tool ![]() SQLite as a documentation creation tool.
0 Comments
Leave a Reply. |
AuthorWrite something about yourself. No need to be fancy, just an overview. ArchivesCategories |