g_it/site
g_it/site
1
0
Fork 0
Code Issues Releases 1 Wiki Activity Actions

Fixed partials and overrides. Added analytics and meta blocks to header.

Browse source
This commit is contained in:
g_it 2026-02-02 20:38:05 +01:00
commit 407ff4b6e9
Signed by untrusted user who does not match committer: g_it
GPG key ID: A2B0A7C06A054627
85 changed files with 77 additions and 11880 deletions
Download patch file Download diff file Expand all files Collapse all files

19
content/resume/pcvue.md
View file

@ -15,10 +15,11 @@ hide:
</style>
> ### Brief<br>
>
> **October 2025**<br>
> Briefly assess the quality of the [product documentation](https://www.pcvue.com/ProductHelp/PcVue/en/Content/AboutHelp/Welcome_PubWeb.php) of PcVue.
![An image of the landing page of documentation section of PcVue](/src/pcvue-documentation-2728x1756.png){ height=300px }
![An image of the landing page of documentation section of PcVue](/assets/media/pcvue-documentation-2728x1756.png){ height=300px }
## Content clarity
@ -28,8 +29,9 @@ hide:
_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..._
{ .annotate }
1. Even if the acronym has been written out elsewhere it needs to be re-introduced on every new page.
2. Mimics are a new concept as well, and the way this is written assumes the reader already knows what they are.
1. Even if the acronym has been written out elsewhere it needs to be re-introduced on every new page.
2. Mimics are a new concept as well, and the way this is written assumes the reader already knows what they are.
---
**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).
@ -47,7 +49,7 @@ This is especially jarring on the landing page of the Product Documentation: PcV
**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.
<figure>
<img src='/src/what-is-hmi.gif' alt='A simple search to find what HMI means'>
<img src='/assets/media/what-is-hmi.gif' alt='A simple search to find what HMI means'>
<figcaption>The search function is slow, fragmented, and can't handle questions</figcaption>
</figure>
@ -73,20 +75,19 @@ This is especially jarring on the landing page of the Product Documentation: PcV
**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.
<div class="grid cards" markdown>
- __PcVue print layout__
- **PcVue print layout**
---
![The PcVue print layout](/src/pcvue-print-layout-1573x1433.png)
![The PcVue print layout](/assets/media/pcvue-print-layout-1573x1433.png)
- __Styled print layout__
- **Styled print layout**
---
![A styled print layout](/src/spread-print-layout-1596x1872.png)
![A styled print layout](/assets/media/spread-print-layout-1596x1872.png)
</div>