1 line
No EOL
43 KiB
JSON
Executable file
1 line
No EOL
43 KiB
JSON
Executable file
{"config":{"separator":"[\\s\\-_,:!=\\[\\]()\\\\\"`/]+|\\.(?!\\d)"},"items":[{"location":"","level":1,"title":"i'm a writer","text":"hi, i'm g* and i write","path":["i'm a writer"],"tags":[]},{"location":"#hover-text","level":4,"title":"...","text":"","path":["i'm a writer"],"tags":[]},{"location":"resume/","level":1,"title":"ResumΓ©","text":"hey, i'm gugulethu and i'm a pen for hire Berlin, Germany(1)<ol><li>π©πͺ German permanent residency</li></ol> 15 years(1)<ol><li>Content Management: 8 yearsCopywriting: 2 yearsTechnical Writing: 5 years</li></ol> Languages(1)<ol><li>English: Fluent (spoken/written)German: B1 (spoken)isiZulu: Fluent (spoken/written)Xhosa: Fluent (spoken/written)Afrikaans: Basic (spoken)French: Basic (spoken)</li></ol> linkedin/gugulet-hu gugulet.hu/dev 2013 2015 2019 2021 2024 Copywriting The Jupiter Drawing Room(1)<ol><li>The Jupiter Drawing Room is an advertising agency that serviced clients across South Africa and Namibia.</li></ol> marketing, advertising, print, radio, television, online, established, private <p>I worked on brands such as Windhoek Beer, Hyundai, Vitaminwater, Sanlam (financial services), Lucky Star (food), and Club Mykonos (accommodation) in print, radio, online, and television. Campaigns where I was the Copywriter have won Gold, Silver, and Bronze Loeries; a Silver Cannes Lion; and a Bronze Clio.</p> Communications Specialist Allan Gray(1)<ol><li>Allan Gray Investment Management is one of the largest asset managers in Africa and operates in South Africa, Namibia, Kenya, Nigeria, Botswana, and other countries.</li></ol> financial services, investment, unit trusts (mutual funds), established, private <p>I created and edited investment content for radio, print, and online; worked in public relations to prepare executives for inrterviews; managed the creation of webinars for outreach to advisers and other creative projects.</p> Content Manager Yoco(1)<ol><li>Yoco is the largest payments processor for small- and medium-businesses in South Africa.</li></ol> financial services, payments, hardware, scale-up, series b <p>Built a content hub from its foundations - including building a team of freelance writers across the country to supply the content. I was involved in developing content for content marketing campaigns and multimedia stories about merchants.</p> Senior Technical Writer Mambu(1)<ol><li>Mambu is a SaaS banking back-end that provides services to banks such as N26 and Solaris.</li></ol> financial services, banking, saas, scale-up, series e Promoted to team lead <p>I was promoted to team lead to manage and mentor two other technical writers. This shifted my role into more managerial tasks on top of working on documentation. </p> Maintained legacy API Reference <p>The API References included old documentation that needed to maintenance for clients that had not yet migrated to the latest versions of the REST API.</p> Documented integrations and CLI <p>Documented integrations with services like nCino and Wise, and documented the Mambu Process Orchestrator - which managed these connections. Also documented the Mambu CLI for external engineers to connect to the back-end.</p> OpenAPI Specification Hugo Shell JavaScript TypeScript Current Documentation Engineer SPREAD.ai(1)<ol><li>SPREAD.ai is a Software-as-a-Service (SaaS) platform for creating actionable and contextualised data for product engineers. The platform counts Volkswagen, Audi, BMW, and other automotive firms as users.</li></ol> manufacturing, automotive, heavy machinery, saas, scale-up, series b Established the documentation function <p>As the first hired technical writer, I established documentation as a function in the company. This includes creating the processes for the Engineering and Product teams to include documentation as a part of the software cycle and onboarding new joiners.</p> Set up the technical infrastructure <p>Built the documentation operations infrastructure from scratch using a Docs-as-Code approach. This included getting a portal up in the first month, building the CI/CD pipeline for publishing and linting content in the first quarter, and setting the procedure for in-app documentation.</p> Achieved 75% product coverage <p>Documented three quarters of the product range with the first documentation set published in the first three months. The product range has since shifted, but coverage remains high - despite being the only person maintaining documentation.</p> GraphQL MkDocs Material Markdown Jinja Vale Ollama Docker Python JavaScript Writing <p>Writing is my primary skill and I'm capable of writing in different formats using different mediums to persuade, teach, and engage. I've been writing professionally for over 15 years and privately since as far as memory can recall.</p> <ul> <li> API documentation <p>Documented REST APIs and GraphQL. With REST APIs worked with a system where annotations in the source code automatically created the reference.</p> </li> <li> Developer content <p>Created developer-focused documentation to create integrations with other financial services and orchestrate services.</p> Read developer docs </li> <li> Hardware documentation <p>Documented Point-of-Sale (POS) devices for small business owners to use. This involved getting user feedback to understand how users were using the devices.</p> </li> <li> Technical theory <p>Created explainer content to give readers an understanding of concepts or ideas behind a tool,technology, or application.</p> See the overview docs </li> <li> Task content <p>Documentation for performing actions and using a tool or an application.</p> Read the tutorial </li> <li> Reference content <p>Reference content is like a dictionary: a term and its definition in a list. I've created glossaries and technical references for developers and non-developers.</p> </li> <li> Course content <p>I've created courses for more in-depth teaching that combines theory and practice in a set lesson plan.</p> Open the intro course </li> <li> Scriptwriting <p>I have written and edited scripts for television and radio, including this advert. </p> </li> </ul> Technical <p>As a one-man technical writing department, my technical skills are important to maintaining Documentation Operations (DocOps) and building infrastructure. I create, service, and maintain all the technical aspects of documentation.</p> Web development html, javascript, css, sass, python, static site generators, node.js, yaml, appsmith DocOps and automation github workflows, vale linting, shell scripting, node red Reading and writing code javascript, python, json, xpath, yaml, openapi spec, graphql, markdown Machine learning ollama, deepseek, qwen, llama, agents, chatbots, comfyui, openweb-ui Built the documentation site of SPREAD.ai and the CI/CD pipeline and review automation process. <pre><code>sequenceDiagram\nautonumber\nβπ½ writer->>βπ½ writer: Collect feedback\nβπ½ writer->>βπ½ writer: Brainstorm content ideas\nβπ½ writer->>βπ½ writer: Write draft content\nβπ½ writer->>π§π½βπ§ technical expert: Check the draft for technical accuracy\nπ§π½βπ§ technical expert->>π§π½βπ§ technical expert: Check content\nNote right of π§π½βπ§ technical expert: Identify issues with draft\nπ§π½βπ§ technical expert-->>βπ½ writer: Revert with issues to fix\nβπ½ writer->>βπ½ writer: Fix issues and send back\nπ§π½βπ§ technical expert->>π§π½βπ§ technical expert: Check content\nNote right of π§π½βπ§ technical expert: Pass content\nπ§π½βπ§ technical expert-->>βπ½ writer: Return pass\nβπ½ writer->>βπ½ other writer: Check draft for language\nβπ½ other writer->>βπ½ other writer: Review language and understanding\nNote right of βπ½ other writer: Note improvements\nβπ½ other writer->>βπ½ writer: Send notes for improvement\nβπ½ writer->>βπ½ writer: Make improvements\nβπ½ writer->>π€ automated check: Check using AI and/or Vale\nπ€ automated check->>βπ½ writer: Return fixes\nβπ½ writer->>βπ½ writer: Prepare and publish final draft</code></pre> Process <p>Publishing content, reviewing content, and managing a tehcnical writing team involves creating processes around people. As a team lead, I've had to define priorities for the documentation function; mentor and manage other writers; create writing and review processes; measure impact; and manage relationships with software engineering teams, marketing and sales, and executives.</p>","path":["ResumΓ©"],"tags":[]},{"location":"writing/","level":1,"title":"Writing","text":"sawubona, i'm g* and i like making pretty arrangements of words","path":["Writing"],"tags":[]},{"location":"qself/qself/","level":1,"title":"Overview","text":"<p>According to legend, the first maxim of the Oracle of Delphi - said to spring from Apollo himself - is to know yourself. Or in Greek: nosce te ipsum, temet nosce. Repeated twice for emphasis and for nuance. Know yourself, to your own self be known. To know and have knowledge of yourself and then to process that knowledge. To know and to accept.</p> <p>The purpose of what has been a decades-long interest for me is exactly that, but a little more. What value do the days 23 September 2004, or 8 July 1995, or 17 February 2017 have if they are remembered and known nowhere. Who were you on these days? We edit our lives like film editors, cutting out the boring bits - but are these not the foundation of who we are. The accumulation of a person are the days without monumental events - where a series of small and large decisions define you, who you were, and who you will be. And in that way this project is also a data diary of a person. In an age where social media networks, search engines, and a hungry horde of algorithms know us better than we know ourselves - this project is my redoubt. I should be the expert of myself, and I should endeavour to be better for that challenge.</p> <p>This documentation set covers the mechanism of collecting, analysing, and displaying information about myself to myself. As such, the primary reader is me - but if you find something of use, please feel free to use it. There will be typos, broken processes, and periods of inactivity - because life doesn't stop for measurements.</p> <p></p>","path":["Overview"],"tags":["HTML","JavaScript","CSS","Python","Shell","Logic","Manual","Database","Collect","Validate","Display","Sync","Analyse","Predict","Watch","Mobile","Laptop"]},{"location":"qself/qself/#principles","level":2,"title":"Principles","text":"<p>Own all the data exclusively Avoid storing any data on external services, even temporarily. This especially applies to health data.</p> <p>Delete nothing Preserve all collected and validated data, as it may have an unimagined use in the future.</p> <p>Automate as much as possible Automate as much of the collection of data as possible to avoid influencing the results. The process should not impinge on the output.</p>","path":["Overview"],"tags":["HTML","JavaScript","CSS","Python","Shell","Logic","Manual","Database","Collect","Validate","Display","Sync","Analyse","Predict","Watch","Mobile","Laptop"]},{"location":"qself/qself/#data-collected","level":2,"title":"Data collected","text":"<p>This list may grow and contract over time, as new data sources are added and others are hidden.</p> <p>Financial: Daily transactions (amount, time, date, category, subcategory, accounts, currency, location, brand, item, liquid balance), Investments (amount, asset type, region, growth/loss), Assets (details, cost, serial, logistics)</p> <p>Health: Exercise (reps, sets, exercises, bpm, location, weather), Metrics (heart rate, resting heart rate, average heart rate, weight, height, haemotocrit, haemoglobin, eosinophils, basophils, lymphocytes, monocytes, neutrophils, platelet count, red cell count, white cell count, mean cell haemoglobin, mean cell volume, mean cell volume, mean corpuscular haemoglobin, red blood width, esr, systolic, diastolic, waist circumference, body fat, chest circumference, thigh circumference, body fat mass, skeletal muscle mass, visceral fat, body water, total cholesterol, hdl cholesterol, ldl cholesterol, triglyceride, pGlucose fasting, anion gap, bicarbonate, chloride, potassium, sodium, urea, creatinine, b12, ferritin, tsh, freet4, thyroid peroxidase, eye axis, eye cylinder, eye sphere, vo2max, avgspo2, sperm motility, sperm count), Sleep (sleep phases, duration, location, weather, air pressure, ambient light, sleep time, awake time)</p> <p>Mental: Media (books, movies, tv, theatre, exhibitions), Productivity (focus sessions), Activities (reading, writing, media, art, games, meditation, technical, media, piano, design)</p> <p>Diagram: Data cycle</p> <p></p>","path":["Overview"],"tags":["HTML","JavaScript","CSS","Python","Shell","Logic","Manual","Database","Collect","Validate","Display","Sync","Analyse","Predict","Watch","Mobile","Laptop"]},{"location":"qself/qself/#roadmap","level":2,"title":"Roadmap","text":"<p>Work on this project is planned and managed on this task board.</p>","path":["Overview"],"tags":["HTML","JavaScript","CSS","Python","Shell","Logic","Manual","Database","Collect","Validate","Display","Sync","Analyse","Predict","Watch","Mobile","Laptop"]},{"location":"qself/financial/","level":1,"title":"Financial","text":"<p>The financial aspect of the qSelf project tracks and processes expenses, investments, income, assets, and logistics:</p> <ul> <li>Expenses: The fundamental unit tracked is transactions. For more information see the Transactions page.</li> <li>Investment: The investment portfolio is tracked using transaction data, with extra information, and is stored in the investment table. For more information see the Investment page.</li> <li>Assets and Logistics: Records asset purchases and monitors their value, state, and location with a logistics component. For more information see the Assets page.</li> </ul>","path":["Financial"],"tags":["HTML","JavaScript","CSS","Logic"]},{"location":"qself/financial/#reconciliation","level":2,"title":"Reconciliation","text":"<p>To keep financial information accurate, the reconciliation flows run on a set schedule to check that the liquid money available, investment portfolio value, asset value, and other balances correspond with the reality. This is the primary function of the <code>4 Finances</code> flow, which serves all the other financial subflows.</p> <p>TBC</p>","path":["Financial"],"tags":["HTML","JavaScript","CSS","Logic"]},{"location":"qself/financial/transactions/","level":1,"title":"Transactions","text":"<p>All financial tracking starts as a transaction, which has the following structure.</p> <p>| Parameter | Type | Description | Required |</p> <p>The logic for collecting transactions is handled by the <code>4a Transactions</code> flow in Automate, which presents an input form, returns the data via query parameters, and enriches the data with exchange rate information, where necessary, and unit cost calculations.</p> <p>TBC</p>","path":["Transactions"],"tags":[]},{"location":"qself/getting-started/","level":1,"title":"Getting started","text":"<p>The qSelf project is made up of a number of inter-connected components:</p> <ul> <li>Logical components: These are responsible for the logical progression of flows, moving data from screens and sensors to the database and further on to displays.</li> <li>Sensory components: These components collect external data from various sensors (mostly from the smartwatch).</li> <li>Input and Display components: These are responsible for receiving manually inputted data that supplements sensory data. The display components display the processed data on dashboards and reports.</li> <li>Analytical components: These components take the received data and parse it into useful information.</li> <li>Storage and Sync components: These components take data and store it in the SQLCipher database or in temp files for quick retrieval.</li> </ul> <p>Components are immutable, but the tools that make them work are replaceable and interchangeable.</p> <p>Diagram: Topology of the qSelf system</p> <p></p>","path":["Getting started"],"tags":[]},{"location":"qself/getting-started/#install","level":2,"title":"Install","text":"","path":["Getting started"],"tags":[]},{"location":"qself/getting-started/#1-install-all-applications-and-tools","level":3,"title":"1. Install all applications and tools","text":"<p>Install all applications in the toolset table. This includes CLI tools that are listed in the Termux row, and plugins for Automate.</p>","path":["Getting started"],"tags":[]},{"location":"qself/getting-started/#2-clone-the-project-repo","level":3,"title":"2. Clone the project repo","text":"<p>Clone the project repo to the root of your user space on your mobile device using Termux and the following commands:</p> <pre><code>cd /storage/emulated/0/\ngit clone git@github.com:gugulet-hu/qself-process.git\n</code></pre>","path":["Getting started"],"tags":[]},{"location":"qself/getting-started/#3-import-flows-into-automate-and-displays-into-kustom","level":3,"title":"3. Import flows into Automate and displays into Kustom","text":"<p>Import the <code>latest.flo</code> files in each of the directories in the qself-process/Automate/ folder. Inside Automate, the dot menu in the top-left corner includes the option to Import. Import the files in the qself-process/Kustom/wallpapers/ folder into KLWP and import the files in the qself-process/Kustom/watchfaces/ folder into KWCH.</p>","path":["Getting started"],"tags":[]},{"location":"qself/getting-started/#4-configure-the-root-settings","level":3,"title":"4. Configure the root settings","text":"<p>Configure the root settings in qself-process/Automate/.demo-config.json file and rename the file to .config.json.</p>","path":["Getting started"],"tags":[]},{"location":"qself/getting-started/#5-start-the-1-context-flow-in-automate","level":3,"title":"5. Start the <code>1 Context</code> flow in Automate","text":"","path":["Getting started"],"tags":[]},{"location":"qself/getting-started/#toolset","level":2,"title":"Toolset","text":"Component Tool Device Description Install Learn Logical Python Python is a general purpose programming language used for data analysis and various scripts. Python TreeHouse Automate Automate is a graphical code tool to create and manage logic on the mobile device. The project also requires these Tasker plugins: AutoWear, AutoInput, Termux:Tasker, Sleep as Android, and Kustom (the last two apps come with their respective Automate plugins). Google Play LlamaLab Sensory wearOS device Any wearOS compatible smartwatch. The TicWatch Pro 5 is recommended for its battery life and general ease of use. It can also be rooted quite easily, unlike Samsung devices. TicWatch Android smartphone The smartphone is a fallback option for certain types of sensory input, such as Steps. The Pixel series is a lean option without the junkware from other Android device manufacturers. You can overlay it with Graphene OS to somewhat protect yourself from Google tracking and annoyances. Pixel Sleep as Android This app is the most reliable sleep tracker for Android. Make sure to turn off the features that send your data to the developer. It is deeply integrated into the way the sleep track flow works. Google Play Docs Input and Display HTML HTML is required foundational knowledge to create web screens to accept manual inputs. CSS CSS is required foundational knowledge to create web screens to accept manual inputs. Better yet, Sass to manage the complexity of some of the input screens. JavaScript JavaScript is required foundational knowledge to create web screens to accept manual inputs. Some JS is also required for using advanced Automate techniques. KLWP Kustom Live Wallpaper allows you to create interactive home screens and is a pretty powerful logical engine of its own. Most of the data is piped to the home screen dashboard for easy access. Google Play Kustom KWCH Kustom Watch Face allows you to create watch faces using the Kustom interface. Like KLWP, it is also capable of doing logical operations. Google Play Kustom Analytical TBA Storage and Sync SQLCipher SQLCipher is the secure version of SQLite. The commands and queries are largely the same, except for the parts to access the database. GitHub Zetetic TablePlus GUI tool for relational databases. In this project used to manually edit the database when things go wrong. Also useful to create queries. TablePlus Docs Termux Termux is a terminal for Android that allows you to send commands for many popular application. For this project it is used for git commands and a couple of advanced techniques. The following packages are installed using the <code>pkg install <package></code> command: curl, gh, git, openssh, python, sqlcipher, termux-api, and termux-tools. GitHub Termux iTerm2 iTerm is my preferred console for macOS. See the description for Termux for which CLI tools to install using the command <code>brew install <package></code>. Homebrew will also need to be installed. iTerm Docs Syncthing Syncthing syncs folders and files across devices. Used to keep the project files updated between the laptop and the smartphone. Syncthing Docs","path":["Getting started"],"tags":[]},{"location":"qself/health/exercise/","level":1,"title":"Test","text":"","path":["Test"],"tags":[]},{"location":"qself/health/metrics/","level":1,"title":"Test","text":"","path":["Test"],"tags":[]},{"location":"qself/health/sleep/","level":1,"title":"Test","text":"","path":["Test"],"tags":[]},{"location":"qself/mental/emotional/","level":1,"title":"Test","text":"","path":["Test"],"tags":[]},{"location":"qself/mental/media/","level":1,"title":"Test","text":"","path":["Test"],"tags":[]},{"location":"qself/mental/productivity/","level":1,"title":"Test","text":"","path":["Test"],"tags":[]},{"location":"qself/reference/devices/","level":1,"title":"Devices","text":"","path":["Devices"],"tags":["Watch","Mobile","Laptop"]},{"location":"qself/reference/devices/#mobile","level":2,"title":"Mobile","text":"<p>The mobile device used in the qSelf project needs to run the Android operating system; preferably the latest version. Most manufacturers add cruft to their devices, so the Pixel series is recommended for its focus on the pure Android experience. Furthermore, the Graphene-flavoured version of Android gives you more control of your privacy and device use compared to standard Android. The device should be unrooted, but with Developer options enabled. This lets you use the Android Debug Bridge (ADB).</p> <p>To install Graphene, see their user guide for instructions.</p>","path":["Devices"],"tags":["Watch","Mobile","Laptop"]},{"location":"qself/reference/devices/#watch","level":2,"title":"Watch","text":"<p>Similarly to the mobile device, the smartwatch needs to run wearOS 3+. The TicWatch series of smartwatches has good battery life and a reasonable number of sensors. You may need to disable or remove additional software added by the manufacturer to get better battery life and less interference. The device should be unrooted, but with Developer options enabled. This lets wirelessly connect using ADB.</p> <p>The commands that follow can help you debloat your device and make it run smoother.</p>","path":["Devices"],"tags":["Watch","Mobile","Laptop"]},{"location":"qself/reference/devices/#connect-to-device","level":3,"title":"Connect to device","text":"<p>Once you have enabled ADB via wi-fi and you have the device's address you can connect to the device run the following command from your terminal or console.</p> CodeExample <pre><code>adb connect <IP-address>\nadb connect <IP-address>:<Port>\n</code></pre> <pre><code>adb connect 192.168.123.132\nadb connect 192.168.123.132:12345\n</code></pre> Part Description Required <code>adb</code> The Android Debugging Bridge CLI tool. To install it on Termux, use: <code>pkg install android-tools</code>. To install it on macOS, using homebrew: <code>brew install android-tools</code>. Yes <code>connect</code> The command to connect over wi-fi to the device. Yes <code><IP-address></code> You can find the IP address on your device when you turn on ADB over wi-fi. It is usually located in Settings > Developer options > Wireless debugging. The command to connect without the port number may be necessary to prompt the permissions dialog, which confirms that you want to connect to this device on the first attempt. Yes <code><Port></code> The port number can usually be found in Settings > Developer options > Wireless debugging. The port number is required when there is more than one device connected via ADB. No","path":["Devices"],"tags":["Watch","Mobile","Laptop"]},{"location":"qself/reference/devices/#grant-permissions-to-apps","level":3,"title":"Grant permissions to apps","text":"<p>To allow autoWear, for example, to change secure settings (such as toggling Theatre Mode) use the following command.</p> CodeExample <pre><code>adb -s \"<IP-address>:<Port>\" shell pm grant <package-name> <permission>\n</code></pre> <pre><code>adb -s \"192.168.123.132:12345\" shell pm grant com.joaomgcd.autowear android.permission.WRITE_SECURE_SETTINGS\n</code></pre> Part Description Required <code>adb</code> The Android Debugging Bridge CLI tool. To install it on Termux, use: <code>pkg install android-tools</code>. To install it on macOS, using homebrew: <code>brew install android-tools</code>. Yes <code>-s</code> This flag selects a particular device when there is more than one device connected via ADB. No <code><IP-address></code> This IP address can be found in Settings > Developer options > Wireless debugging. The command to connect without the port number may be necessary to prompt the permissions dialog, which confirms that you want to connect to this device on the first connection. Yes <code><Port></code> The port number is in Settings > Developer options > Wireless debugging. The port number is required when there is more than one device connected via ADB. No <code>shell</code> The shell for interacting with ADB. Yes <code>pm</code> Short for package manager, which manages apps on an Android or wearOS device. Yes <code>grant <package-name> <permission></code> Grant this package these permissions on the device. Yes","path":["Devices"],"tags":["Watch","Mobile","Laptop"]},{"location":"qself/reference/devices/#list-system-apps","level":3,"title":"List system apps","text":"<p>To list all the manufacturer applications installed.</p> CodeExample <pre><code>adb -s \"<IP-address>:<Port>\" shell pm list packages -s -e <manufacturer-name>\n</code></pre> <pre><code>adb -s \"192.168.123.132:12345\" shell pm list packages -s -e mobvoi\n</code></pre> Part Description Required <code>adb</code> The Android Debugging Bridge CLI tool. To install it on Termux, use: <code>pkg install android-tools</code>. To install it on macOS, using homebrew: <code>brew install android-tools</code>. Yes <code>-s</code> This flag selects a particular device when there is more than one device connected via ADB. No <code><IP-address></code> This IP address can be found in Settings > Developer options > Wireless debugging. The command to connect without the port number may be necessary to prompt the permissions dialog, which confirms that you want to connect to this device on the first attempt. Yes <code><Port></code> The port number is in Settings > Developer options > Wireless debugging. The port number is required when there is more than one device connected via ADB. No <code>shell</code> The shell for interacting with ADB. Yes <code>pm</code> Short for package manager, which manages apps on an Android or wearOS device. Yes <code>list packages</code> List all the packages that meet the conditions that follow. Yes <code>-s</code> A flag to filter for system apps. No <code>-e</code> A flag to filter for enabled apps. To filter for disabled apps use <code>-d</code>. No","path":["Devices"],"tags":["Watch","Mobile","Laptop"]},{"location":"qself/reference/devices/#disable-system-apps","level":3,"title":"Disable system apps","text":"<p>To disable a manufacturer's app on your device.</p> CodeExample <pre><code>adb -s \"<IP-address>:<Port>\" shell pm disable-user --user 0 <package-name>\n</code></pre> <pre><code>adb -s \"192.168.123.132:12345\" shell pm disable-user --user 0 com.mobvoi.wear.mcuservice.aw\n</code></pre> Part Description Required <code>adb</code> The Android Debugging Bridge CLI tool. To install it on Termux, use: <code>pkg install android-tools</code>. To install it on macOS, using homebrew: <code>brew install android-tools</code>. Yes <code>-s</code> This flag selects a particular device when there is more than one device connected via ADB. No <code><IP-address></code> This IP address can be found in Settings > Developer options > Wireless debugging. The command to connect without the port number may be necessary to prompt the permissions dialog, which confirms that you want to connect to this device on the first attempt. Yes <code><Port></code> The port number is in Settings > Developer options > Wireless debugging. The port number is required when there is more than one device connected via ADB. No <code>shell</code> The shell for interacting with ADB. Yes <code>pm</code> Short for package manager, which manages apps on an Android or wearOS device. Yes <code>disable-user --user 0</code> Disable the following app on the device. Yes <code><package-name></code> The name of the package to disable. You can find the package names by listing the packages. Yes","path":["Devices"],"tags":["Watch","Mobile","Laptop"]},{"location":"qself/reference/devices/#laptop","level":2,"title":"Laptop","text":"<p>Any laptop that can run Python is good enough for this project.</p> <p>Using commands in Powershell</p> <p>Please be aware that some terminal commands in Linux and macOS are different in Windows Powershell. There may be instances where you need to use ticks (`) to escape ceratin characters.</p>","path":["Devices"],"tags":["Watch","Mobile","Laptop"]},{"location":"resume/establish-spread-docs/","level":1,"title":"Establish SPREAD documentation","text":"<p> MkDocs Material β
GraphQL β
JavaScript β
Python β
Jinja β
MarkDown β
Vale β
GitHub Actions β
Docker</p> <p></p>","path":["Establish SPREAD documentation"],"tags":[]},{"location":"resume/establish-spread-docs/#brief","level":3,"title":"Brief","text":"<p>February 2022 Establish the documentation function at SPREAD.</p>","path":["Establish SPREAD documentation"],"tags":[]},{"location":"resume/establish-spread-docs/#challenge","level":2,"title":"Challenge","text":"<p>There was no documentation, except for a few Confluence pages put together by engineers. The challenge was to create a documentation site, create the processes and pipelines to maintain it, and to write the content. The task was made more difficult by the fact that the product was constantly changing and I had engineering time to lean on.</p>","path":["Establish SPREAD documentation"],"tags":[]},{"location":"resume/establish-spread-docs/#solution","level":2,"title":"Solution","text":"<p>In the first three months:</p> <ul> <li>Evaluated and selected options for the technical infrastructure.</li> <li>Socialized the newly established function in the company.</li> <li>Created the internal website.</li> <li>Created the initial build pipelines.</li> <li>Got to 50% product coverage.</li> <li>Wrote an initial style guide for general contributions</li> </ul> <p></p> <p>In the second quarter:</p> <ul> <li>Got product coverage to 90%.</li> <li>Moved to multi-repo setup, where engineering teams \"owned\" their content and maintained updates.</li> <li>Built the linting pipelines for general contributions.</li> <li>Document white-labelled products with internal customisations.</li> </ul> <p></p> <p>Within the first year:</p> <ul> <li>Publish the documentation site publicly.</li> <li>Publish the SPREAD glossary of terms.</li> <li>Create course content for new users.</li> </ul> <p>Within the last year:</p> <ul> <li>Move to a mono-repo setup.</li> <li>Create more course content.</li> <li>Add AI enhancements to the build pipeline.</li> <li>Better monitoring of product changes.</li> <li>Re-start initiative for more people to write documentation.</li> </ul> <p>See the site</p> <p>See my rΓ©sume</p> linkedin/gugulet-hu gugulet.hu/dev","path":["Establish SPREAD documentation"],"tags":[]},{"location":"resume/mambu-cli/","level":1,"title":"Mambu CLI","text":"<p> TypeScript β
NodeJS</p> <p></p>","path":["Mambu CLI"],"tags":[]},{"location":"resume/mambu-cli/#brief","level":3,"title":"Brief","text":"<p>November 2023 Create documentation for a command-line interface (CLI) used by banking engineering teams to perform actions in Mambu.</p>","path":["Mambu CLI"],"tags":[]},{"location":"resume/mambu-cli/#challenge","level":2,"title":"Challenge","text":"<p>Document the command-line context as efficiently as possible, with little support from the developing team. Mambu CLI was in prototype and the team had no time to help me document the commands, flags, topics, and functioning of the CLI.</p>","path":["Mambu CLI"],"tags":[]},{"location":"resume/mambu-cli/#solution","level":2,"title":"Solution","text":"<p>Embedded documentation with the engineering team, where I was part of the race to beta. Engineers would develop a feature alongside me and I would be in the code documenting. This involved working in TypeScript and translating the concepts and trials engineers were developing with them.</p> <p>See my rΓ©sume</p> linkedin/gugulet-hu gugulet.hu/dev","path":["Mambu CLI"],"tags":[]},{"location":"resume/mambu-process-orchestrator/","level":1,"title":"Mambu Process Orchestrator","text":"<p> Hugo</p> <p></p>","path":["Mambu Process Orchestrator"],"tags":[]},{"location":"resume/mambu-process-orchestrator/#brief","level":3,"title":"Brief","text":"<p>March 2021 Own the documentation for the low-code orchestrator for integrations into banking services.</p>","path":["Mambu Process Orchestrator"],"tags":[]},{"location":"resume/mambu-process-orchestrator/#challenge","level":2,"title":"Challenge","text":"<p>Mambu Process Orchestrator - a white-labelled product built on top of the Corezoid low-code engine - had no documentation, but was already being used by clients. Some with highly complex workflows that were beginning to break in unexpected ways in an environment where no failure could be tolerated. The underlying technology was built by a Ukrainian company, who were under strain following the invasion by Russia in the same time period.</p>","path":["Mambu Process Orchestrator"],"tags":[]},{"location":"resume/mambu-process-orchestrator/#solution","level":2,"title":"Solution","text":"<p>Partner with Corezoid to help them develop their documentation alongside ours. Get field-tested best practices from clients who were using the tool. Ask the Solution Engineers to sketch out the most urgent work needed and the scope they cover when working with clients. Compile a documentation set in the shortest time possible to fill this documentation gap.</p> <p>Read the documentation set</p> <p>See my rΓ©sume</p> linkedin/gugulet-hu gugulet.hu/dev","path":["Mambu Process Orchestrator"],"tags":[]},{"location":"resume/pcvue/","level":1,"title":"PcVue assessment","text":"","path":["PcVue assessment"],"tags":[]},{"location":"resume/pcvue/#brief","level":3,"title":"Brief","text":"<p>October 2025 Briefly assess the quality of the product documentation of PcVue.</p>","path":["PcVue assessment"],"tags":[]},{"location":"resume/pcvue/#content-clarity","level":2,"title":"Content clarity","text":"<p>Acronyms and technical jargon: The documentation generally assumes familiarity with acronyms like HMI and SCADA. It would benefit from brief explanations in these areas. For example, this is from the first paragraph of an overview page:</p> <p>The HMI (1) for your project is composed of mimics. Mimics (2) are easily and quickly developed to form menus, overviews, process diagrams, trend viewers and so on...</p> <ol> <li>Even if the acronym has been written out elsewhere it needs to be re-introduced on every new page.</li> <li>Mimics are a new concept as well, and the way this is written assumes the reader already knows what they are.</li> </ol> <p>Assumed knowledge: Many pages presuppose a significant amount of technical knowledge, which could confuse readers - especially those new to the industry. The first principle of technical writing is that every page is page one and the reader should find all the context they need on the page (or linked on the page).</p> <p>This is especially jarring on the landing page of the Product Documentation: PcVue has the description HMI/SCADA, FrontVue has the description Light HMI, and EmVue has the description Energy Monitoring. Of those, only EmVue is understandable to a new user. Using full blurbs that describe what the documentation set contains would be better for understanding.</p> <p>Use-cases: The absence of real-world use cases leaves a gap in understanding how the software works in practice. There are marketing use-cases on the main website, but they would do more to give product documentation clarity.</p>","path":["PcVue assessment"],"tags":[]},{"location":"resume/pcvue/#user-experience","level":2,"title":"User experience","text":"<p>User experience: Any documentation set that needs meta-documentation - like the About this documentation section - is signalling that it is not intuitive enough to use. A reader should not have to know about logical operators to use search functionality and interpret icons to understand their meaning. Good intuitive documentation sets don't need meta-documentation to understand how to use the documentation.</p> <p>Search functionality: The search feature needs enhancement to accommodate natural language queries rather than expecting users to know logical operators or regular expressions. Every reader's expectation is a search experience as good as Google; especially as the main way to navigate a large documentation set is through the search box.</p> The search function is slow, fragmented, and can't handle questions <p>Getting Started section: Preferably you need a Getting Started or QuickStart section. The installation minutiae gets in the way of someone who just wants the golden path. Notably, the main installation instructions are listed as the sixth item in the menu under the installation section.</p>","path":["PcVue assessment"],"tags":[]},{"location":"resume/pcvue/#information-architecture","level":2,"title":"Information architecture","text":"<p>Linking examples with theory: Examples should be integrated with related theoretical content instead of being isolated, like in the Application Architect section, where the Examples section is separate. This approach reinforces learning through immediate application.</p> <p>Content types: The content needs to be divided into content types more clearly: theory content, tutorial content, and reference content. There is an inconsistency in how the sections are organized. For example, the Application Architect section has a glossary, but the others do not. The DiΓ‘taxis for technical writing explains content types and where they are applicable in more depth.</p> <p>Headings and page structure: Headings are an indicator of page structure for search engines and for AI answer engines. Headings like \"Example 1\", \"The secondary navigation tree pop-up menu\", \"For the LAN Manager\", and similar mean nothing in isolation - which is how engines parse a website.</p> <p>Interlinking: The content is light on internal links. There are See more boxes, but the linking between pages is relatively absent for documentation describing one product. Internal linking helps readers make sense of the product as a whole and are critical for Search Engine Optimization (SEO).</p>","path":["PcVue assessment"],"tags":[]},{"location":"resume/pcvue/#design-and-technical","level":2,"title":"Design and technical","text":"<p>Page load times: PHP, the language that MadCap Flare outputs content to, is slow and the documentation site has a noticeable lag when navigating pages and using search. A server-side language is good for dynamic content, but hamstrings static content - which is mainly how documentation is presented.</p> <p>Print layout: The print layout when using the print button is not well-styled for PDFs or physical printing. The text is too small, the spacing and styling is a facsimile of the web view when it should be simplified for the print view. Some compliance functions need good PDF functionality to prove that content was made available at a certain time for auditing purposes.</p> <ul> <li> <p>PcVue print layout</p> <p></p> </li> <li> <p>Styled print layout</p> <p></p> </li> </ul> <p>Lists and tables: When to use a table, a list, or another element should be clearer. There were instances were a table would have been better than a list and vise-versa. The formatting of both needs attention: lists are too spaced out and tables contain multiple header rows in the same table.</p> <p>Diagrams and images: Diagrams are a great tool for getting information across visually, particularly to illustrate complex processes and concepts. There are no diagrams in the documentation. Tools like Mermaid allow you to create diagrams dynamically, without using image editing application. The general quality of the screenshots and images is low, and there are no captions. Captions are important for SEO and for accessibility for visually impaired readers. Having images under Show pictures dropdowns is a suboptimal user experience. It's an additional click for little gain.</p> <p>Font and presentation layer: The font on the main site is more legible and overall styling is more visually appealing compared to the documentation site. Presentation matters, even for highly technical audiences.</p> <p>Admonition overuse: Excessive use of admonitions can diminish their impact. There are multiple pages with more than five admonitions per page. If everything is important, nothing is important. Itβs essential to limit their frequency to maintain emphasis.</p>","path":["PcVue assessment"],"tags":[]},{"location":"resume/pcvue/#general","level":2,"title":"General","text":"<p>The documentation is arranged around how the company views the software and not how users use it. A compliance and audit professional would benefit from a user flow designed for their needs and understanding, same for an integration or process engineer.</p> <p>The documentation is written like a book, with the expectation that readers will read from top to bottom. This is not how people read documentation. Documentation is primarily driven by search and read in snippets. Readers come with questions and expect answers with full context in a nutshell.</p> <p>The language scores highly on the Flesch-Kincaid Grade Level, indicating that it can be improved for clarity and flow. This would need a full review of the content to set standards that make it more readable and understandable.</p> <p>As a reader I get the sense the chapters have been written by different people and the documentation set does not work together.</p> <p>My general recommendation would be an overhaul, starting with the information architecture, a technical infrastructure review, and then a general language and style standards review.</p> <p>See my rΓ©sume</p> linkedin/gugulet-hu gugulet.hu/dev","path":["PcVue assessment"],"tags":[]}]} |