| |
| en:multiasm:ai_proofread [2026/06/19 16:46] – created raivo.sell | en:multiasm:ai_proofread [2026/06/19 16:54] (current) – external edit 127.0.0.1 |
|---|
| ====== AI automatic proofread ====== | ====== AI automatic proofread ====== |
| |
| <note>Prompt:</note> | <note>Prompt: Using the links in [[en:multiasm:toc|toc.txt]] as the basis, go through all those pages and check whether you can find grammar errors or other problematic spelling issues.</note> |
| | |
| | ---- |
| | |
| | ===== MultiASM TOC proofread report ====== |
| | |
| | This report lists grammar, spelling, style, and formatting issues found by reviewing all internal DokuWiki links in [[en:multiasm:toc|toc.txt]]. External URLs, [[en:multiasm:todo|todo]], and [[en:multiasm:versions|versions]] were not reviewed as editorial content. |
| | |
| | **Scope:** [[en:multiasm:authors]], [[en:multiasm:preface]], [[en:multiasm:disclaimer]], [[en:multiasm:introduction]], [[en:multiasm:cs]] and all linked chapters, [[en:multiasm:paiot]] and [[en:multiasm:piot:chapter_4_*]], [[en:multiasm:paarm]] and linked chapters, [[en:multiasm:papc]] and linked chapters, plus [[en:iot-open:rules]]. |
| | |
| | **Date:** 2026-06-19 |
| | |
| | ---- |
| | |
| | ===== Critical / obvious errors ===== |
| | |
| | Likely copy-paste, editor leftovers, or clear typos. These should be fixed before the next PDF generation. |
| | |
| | <table proofread_critical> |
| | <caption>Critical issues</caption> |
| | ^ Page ^ Location ^ Issue ^ Suggested fix ^ |
| | | [[en:multiasm:piot:chapter_4_8]] | Interrupt vector layout, example line | Norwegian text embedded in English: `Example:Vis mindreKodeblokk er utvidet` | Replace with `Example:` followed by the code block only | |
| | | [[en:multiasm:piot:chapter_4_2]] | Figure caption `avr_architecture` | Test caption: `AVR Architecture Raivo test` | Use a proper caption, e.g. `AVR Architecture` | |
| | | [[en:multiasm:piot:chapter_4_5]] | Program memory post-increment section | `As shown in Fing` | `As shown in Fig` | |
| | | [[en:multiasm:piot:chapter_4_5]] | Same section | `elmp Z+` | `elpm Z+` | |
| | | [[en:multiasm:piot:chapter_4_5]] | Code example | `LMP Z+` | `LPM Z+` | |
| | | [[en:multiasm:papc:chapter_6_1]] | Pentium section | `I can operate with the clock frequency` | `It can operate with the clock frequency` | |
| | | [[en:multiasm:papc:chapter_6_9]] | Opening paragraph | `to have the main application is written` | `to have the main application written` or `to write the main application` | |
| | | [[en:multiasm:cs:chapter_3_12]] | Opening paragraph | `instead is an interrupt controller in the system collects` | `instead, an interrupt controller in the system collects` | |
| | | [[en:multiasm:cs:chapter_3_12]] | Interrupt handling figure description | `Next jumps to the interrupt handler` | `Next, it jumps to the interrupt handler` or `Then it jumps` | |
| | | [[en:multiasm:cs:chapter_3_12]] | Non-maskable interrupts | `If an interrupt cannot be disabled, is called` | `If an interrupt cannot be disabled, it is called` | |
| | | [[en:multiasm:cs:chapter_3_12]] | Aborts list item | `program of computer behaviour` | `program or computer behaviour` | |
| | | [[en:multiasm:preface]] | Target audience paragraph | `persons ... possess ... and knows the general concept` | `persons ... possess ... and know the general concept` (subject-verb agreement) | |
| | </table> |
| | |
| | ---- |
| | |
| | ===== Spelling and terminology ===== |
| | |
| | <table proofread_spelling> |
| | <caption>Spelling and terminology</caption> |
| | ^ Page ^ Issue ^ Suggested fix ^ |
| | | [[en:multiasm:introduction]] | `microampers` | `microamperes` or `microamps` | |
| | | [[en:multiasm:piot:chapter_4_9]] | Comment in code: `agrument %0` | `argument %0` | |
| | | [[en:multiasm:paarm:chapter_5_2]] | Image alt text | `MMachine code` → `Machine code` | |
| | | [[en:multiasm:paarm:chapter_5_2]] | Shift options table | `ROtate Right` | `Rotate Right` | |
| | | [[en:multiasm:papc:chapter_6_7]] | CMPXCHG section | `cmpxch16b` | `cmpxchg16b` | |
| | | [[en:multiasm:cs:chapter_3_10]] | Jump addressing example | `hypothetic //jump//` (line 78; line 6 already uses `hypothetical`) | Use `hypothetical` consistently | |
| | | [[en:multiasm:disclaimer]] | Consortium image caption | `Consortium Partner's Logos` | `Consortium Partners' Logos` (plural possessive) | |
| | | [[en:iot-open:rules]] | Note plugin example | `some useful tip for reades` | `some useful tip for readers` | |
| | </table> |
| | |
| | ---- |
| | |
| | ===== Grammar and style ===== |
| | |
| | <table proofread_grammar> |
| | <caption>Grammar and style</caption> |
| | ^ Page ^ Issue ^ Suggested fix ^ |
| | | [[en:multiasm:introduction]] | ESP32 paragraph: comma splice — `...the only programming language available is assembler, it is compact enough...` | Split into two sentences or join with `;` / `and` | |
| | | [[en:multiasm:paarm]] | `graphics processing unit(GPU)` and `digital signal processor(DSP)` | Add space before opening parenthesis | |
| | | [[en:multiasm:paarm]] | `The cortex-R series` | `The Cortex-R series` (consistent product naming) | |
| | | [[en:multiasm:paarm]] | `Cortex-X series processors ... It supports up to 14 cores` | `They support up to 14 cores` (plural subject) | |
| | | [[en:multiasm:paarm:chapter_5_1]] | `new malwares` | `new malware` (uncountable) | |
| | | [[en:multiasm:paarm:chapter_5_1]] | `Such malware, like "Spectre" and "Meltdown", perform` | `performs` (if subject is `malware`) | |
| | | [[en:multiasm:paarm:chapter_5_15]] | `The Linux exposes CPU frequency scaling` | `Linux exposes CPU frequency scaling` | |
| | | [[en:multiasm:paarm:chapter_5_15]] | Closing paragraph | Incomplete sentence: `By changing the stored path in //gov_path// variable and //gov_value// value.` | Complete the main clause | |
| | | [[en:multiasm:piot:chapter_4_5]] | Displacement addressing | `The addressing with displacement calculated the sum` | `The addressing with displacement calculates the sum` | |
| | | [[en:multiasm:piot:chapter_4_5]] | Direct single register addressing | `The example of such instruction can be register incrementation` | `An example of such an instruction is register increment` | |
| | | [[en:multiasm:piot:chapter_4_2]] | Other architectures intro | `We depict some of them shortly` | `We briefly describe some of them` | |
| | | [[en:multiasm:piot:chapter_4_4]] | Opening paragraph | `This course will discuss` | `This chapter will discuss` or `This book discusses` | |
| | | [[en:multiasm:piot:chapter_4_7]] | Opening paragraph | `This course will discuss` | Same as above | |
| | | [[en:multiasm:paiot]] | `Programming in an assembler requires` | `Programming in assembler requires` | |
| | | [[en:multiasm:paiot]] | `an assembler enables efficient use` | `assembler enables efficient use` | |
| | | [[en:multiasm:papc:chapter_6_6]] | Repeat prefixes | `behaviour of instruction` | `behaviour of the instruction` | |
| | | [[en:multiasm:papc:chapter_6_7]] | Undefined instructions | `invalid opcode exception (#UD) throw` | `invalid opcode exception (#UD) is raised` or `is thrown` | |
| | | [[en:multiasm:cs:chapter_3_6]] | Volatile memories section | `Volatile memory is used ... Their content is lost` | `Its content is lost` (subject is singular `memory`) | |
| | | [[en:multiasm:piot:chapter_4_9]] | Example heading | `Blink inbuilt LED` | `Blink built-in LED` | |
| | | [[en:multiasm:piot:chapter_4_11]] | PDI description | `PDI (Program and Debug Interface) PDI is` | Remove duplicate `PDI` or add punctuation after the definition | |
| | </table> |
| | |
| | ---- |
| | |
| | ===== Formatting and consistency ===== |
| | |
| | <table proofread_format> |
| | <caption>Formatting and consistency</caption> |
| | ^ Page ^ Issue ^ Suggested fix ^ |
| | | [[en:multiasm:cs:chapter_3_4]] | Page title | `======Components of Processor` — missing space after `======` | `====== Components of Processor ... ======` | |
| | | [[en:multiasm:cs:chapter_3_6]] | Page title | `====== Memory, Types and Their Functions======` — spacing around closing `======` | `====== Memory, Types and Their Functions ======` | |
| | | [[en:multiasm:cs:chapter_3_9]] | Figure `pipeline8086` alt text | Image alt: `2-stage pipeline in 8086 microprocessor` | Caption and body text describe a **4-stage** pipeline — align alt text and caption with the text | |
| | | [[en:multiasm:cs:chapter_3_3]] | CISC/RISC table | `Non destroying instructions` | `Non-destroying instructions` | |
| | | [[en:multiasm:piot:chapter_4_2]] | Subheading | `====Other Architectures====` | `==== Other Architectures ====` | |
| | | [[en:multiasm:paarm:chapter_5_2]] | GNU ARM ASM reference | `{ https://sourceware.org/binutils/docs-2.26/as/}` | Use proper DokuWiki link syntax | |
| | | [[en:multiasm:piot:chapter_4_8]] | HAL section heading | `** 1. Hardware Abstraction Layer (HAL) ***` | Remove extra asterisks for consistent markup | |
| | </table> |
| | |
| | ---- |
| | |
| | ===== UK vs US English ===== |
| | |
| | The book rules ([[en:iot-open:rules|Writing rules]]) specify UK English. The following US forms appear in reviewed pages (official document titles may stay as published): |
| | |
| | <table proofread_ukus> |
| | <caption>UK vs US English</caption> |
| | ^ Page ^ US form found ^ UK form ^ |
| | | [[en:multiasm:piot:chapter_4_1]] | `revolutionizing` | `revolutionising` | |
| | | [[en:multiasm:piot:chapter_4_10]] | `optimization` | `optimisation` | |
| | </table> |
| | |
| | <note>References to vendor documents such as "Intel® 64 and IA-32 Architectures Optimization" and "Software Optimization Guide" should retain the original published titles.</note> |
| | |
| | ---- |
| | |
| | ===== Terminology notes (optional improvements) ===== |
| | |
| | These are not strict errors but worth standardising across the book: |
| | |
| | * **Assembler language** — several pages use `the assembler language` or `in the assembler language`. Common technical English prefers **assembly language** or **programming in assembler** (without `the`). |
| | * **Incrementation / decrementation** — used in [[en:multiasm:cs:chapter_3_10]] and [[en:multiasm:papc:chapter_6_7]]. Acceptable in technical writing, but **increment** / **decrement** or **pre-increment** / **post-decrement** are more usual. |
| | * **Arithmetical** — [[en:multiasm:cs:chapter_3_4]] uses `arithmetical calculations`; **arithmetic** is more common in UK technical English. |
| | * **Authors page** — [[en:multiasm:authors]] uses `M. sc.`; standard form is **M.Sc.** |
| | |
| | ---- |
| | |
| | ===== Overall assessment ===== |
| | |
| | The reviewed material is largely accurate and professional, especially in the computer architecture chapters ([[en:multiasm:cs]]). Most issues are: |
| | |
| | * isolated editor or translation leftovers (Norwegian text, test caption, `Fing`, `I` vs `It`); |
| | * inconsistent wording (`hypothetic` / `hypothetical`, `This course` vs book context); |
| | * article use with **assembler** (`an assembler` vs **assembler**); |
| | * heading and image caption formatting. |
| | |
| | **Highest priority fixes:** [[en:multiasm:piot:chapter_4_8]] (Norwegian text), [[en:multiasm:piot:chapter_4_5]] (`Fing`, `elmp`, `LMP`), [[en:multiasm:papc:chapter_6_1]] (`I` → `It`), and [[en:multiasm:cs:chapter_3_12]] (interrupt section grammar). |
| | |
| | ---- |
| | |
| | <WRAP excludefrompdf> |
| | This page is a working proofread report generated by AI. It is not part of the printed book. |
| | </WRAP> |
