Fixed partials and overrides. Added analytics and meta blocks to header.
This commit is contained in:
g_it
parent
71130424e3
commit
407ff4b6e9
GPG key ID:
A2B0A7C06A054627
85 changed files with 77 additions and 11880 deletions
|
|
@ -24,12 +24,13 @@ div.tooling p {
|
|||
</style>
|
||||
|
||||
> ### Brief<br>
|
||||
>
|
||||
> **February 2022**<br>
|
||||
> Establish the documentation function at SPREAD.
|
||||
|
||||
<div class='tooling' markdown>:simple-materialformkdocs: MkDocs Material ⋅ :material-graphql: GraphQL ⋅ :material-language-javascript: JavaScript ⋅ :material-language-python: Python ⋅ :simple-jinja: Jinja ⋅ :material-language-markdown: MarkDown ⋅ :simple-v: Vale ⋅ :simple-githubactions: GitHub Actions ⋅ :material-docker: Docker</div>
|
||||
|
||||
{ height=300px }
|
||||
{ height=300px }
|
||||
|
||||
## Challenge
|
||||
|
||||
|
|
@ -46,7 +47,7 @@ There was no documentation, except for a few Confluence pages put together by en
|
|||
- Got to 50% product coverage.
|
||||
- Wrote an initial style guide for general contributions
|
||||
|
||||
{ height=300px }
|
||||
{ height=300px }
|
||||
|
||||
**In the second quarter:**
|
||||
|
||||
|
|
@ -55,7 +56,7 @@ There was no documentation, except for a few Confluence pages put together by en
|
|||
- Built the linting pipelines for general contributions.
|
||||
- Document white-labelled products with internal customisations.
|
||||
|
||||
{ height=300px }
|
||||
{ height=300px }
|
||||
|
||||
**Within the first year:**
|
||||
|
||||
|
|
@ -87,4 +88,4 @@ There was no documentation, except for a few Confluence pages put together by en
|
|||
<span class='twemoji'><svg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 24 24'><path d='M2.6 10.59 8.38 4.8l1.69 1.7c-.24.85.15 1.78.93 2.23v5.54c-.6.34-1 .99-1 1.73a2 2 0 0 0 2 2 2 2 0 0 0 2-2c0-.74-.4-1.39-1-1.73V9.41l2.07 2.09c-.07.15-.07.32-.07.5a2 2 0 0 0 2 2 2 2 0 0 0 2-2 2 2 0 0 0-2-2c-.18 0-.35 0-.5.07L13.93 7.5a1.98 1.98 0 0 0-1.15-2.34c-.43-.16-.88-.2-1.28-.09L9.8 3.38l.79-.78c.78-.79 2.04-.79 2.82 0l7.99 7.99c.79.78.79 2.04 0 2.82l-7.99 7.99c-.78.79-2.04.79-2.82 0L2.6 13.41c-.79-.78-.79-2.04 0-2.82'></path></svg></span> gugulet.hu/dev
|
||||
</div>
|
||||
</a>
|
||||
</div>
|
||||
</div>
|
||||
|
|
|
|||
|
|
@ -24,13 +24,13 @@ div.tooling p {
|
|||
</style>
|
||||
|
||||
> ### Brief<br>
|
||||
>
|
||||
> **November 2023**<br>
|
||||
> Create documentation for a command-line interface (CLI) used by banking engineering teams to perform actions in Mambu.
|
||||
|
||||
<div class='tooling' markdown>:material-language-typescript: TypeScript ⋅ :material-nodejs: NodeJS</div>
|
||||
|
||||
|
||||
{ height=300px }
|
||||
{ height=300px }
|
||||
|
||||
## Challenge
|
||||
|
||||
|
|
|
|||
|
|
@ -24,12 +24,13 @@ div.tooling p {
|
|||
</style>
|
||||
|
||||
> ### Brief<br>
|
||||
>
|
||||
> **March 2021**<br>
|
||||
> Own the documentation for the low-code orchestrator for integrations into banking services.
|
||||
|
||||
<div class='tooling' markdown>:simple-hugo: Hugo</div>
|
||||
|
||||
{ height=300px }
|
||||
{ height=300px }
|
||||
|
||||
## Challenge
|
||||
|
||||
|
|
@ -55,4 +56,4 @@ Partner with Corezoid to help them develop their documentation alongside ours. G
|
|||
<span class='twemoji'><svg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 24 24'><path d='M2.6 10.59 8.38 4.8l1.69 1.7c-.24.85.15 1.78.93 2.23v5.54c-.6.34-1 .99-1 1.73a2 2 0 0 0 2 2 2 2 0 0 0 2-2c0-.74-.4-1.39-1-1.73V9.41l2.07 2.09c-.07.15-.07.32-.07.5a2 2 0 0 0 2 2 2 2 0 0 0 2-2 2 2 0 0 0-2-2c-.18 0-.35 0-.5.07L13.93 7.5a1.98 1.98 0 0 0-1.15-2.34c-.43-.16-.88-.2-1.28-.09L9.8 3.38l.79-.78c.78-.79 2.04-.79 2.82 0l7.99 7.99c.79.78.79 2.04 0 2.82l-7.99 7.99c-.78.79-2.04.79-2.82 0L2.6 13.41c-.79-.78-.79-2.04 0-2.82'></path></svg></span> gugulet.hu/dev
|
||||
</div>
|
||||
</a>
|
||||
</div>
|
||||
</div>
|
||||
|
|
|
|||
|
|
@ -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.
|
||||
|
||||
{ height=300px }
|
||||
{ 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**
|
||||
|
||||
---
|
||||
|
||||
|
||||
|
||||
|
||||
- __Styled print layout__
|
||||
- **Styled print layout**
|
||||
|
||||
---
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue