Skip to content

Manual easier to read: glossary, go-live checklist, task tables, plain sentences, new diagrams - #428

Merged
oblomov-dev merged 6 commits into
mainfrom
claude/fervent-hawking-bo7lxc
Nov 12, 2026
Merged

oblomov-dev merged 6 commits into
mainfrom
claude/fervent-hawking-bo7lxc

Conversation

@oblomov-dev

Copy link
Copy Markdown
Member

What changes

New pages

  • Glossary (Getting Started): one word per thing — roundtrip, app instance, app draft (told apart from the RAP draft), view, model, binding, event, frontend action, sub-app, user exit — and a "if you know X, then here it is Y" table.
  • AI Setup: The Recommended Path: three steps with one command each, what each costs, and a tool map. The other AI pages link to it instead of restating their own ladders.
  • Lock: Full Source and RAP Draft: The Full Edit Screen: the long listings of the two 1,000-line pages; the original pages keep the overview and the short snippets.

Newcomer path

  • Quickstart: the SICF step as numbered clicks; the verification names the expected result of each step (labels taken from the startup app's source).
  • Every tutorial step says what you should see. Steps 6, 8 and 10 name what is new.
  • check_on_navigated, n / v / ns, roundtrip and draft are explained where they first appear.

Configuration

  • Productive Usage is now the Go-Live Checklist (same address) and opens the chapter: what, where, how to verify, plus a production exit class to copy.
  • Security shows how to send the CSP as a response header, which the go-live table asked for and no page showed.
  • Deployment Scenarios is a decision table; Authorization and User Exits state their rules as tables; Monitoring puts the operator part first.

Cookbook

  • The index and the cheat sheet open with an "I want to… → call" table.
  • Ten pages are named after the task (Building a View, Handling Events in ABAP, More than 100 Rows, …). File names and addresses are unchanged; changed headings keep their old anchor.
  • Every example dispatches through one check_on_init / check_on_navigated / check_on_event chain.
  • One word per thing: app draft, sub-app, frontend action, event binding.

Language

  • Sentences over 35 words: 8.1% → 1.3% of the manual. npm run report:sentences lists the rest; it is a report and not part of npm run check.

Pictures

  • Seven new diagrams: table binding, URL modes, frontend actions, the request path and who checks what, the lost update, RAP draft states, the AI tool map.
  • Fresh English screenshots of the Developer Tools and the startup page, hosted here.
  • The copied diagrams follow the insights originals again (readable secondary text).

Sidebar

  • Go-Live Checklist first under Configuration; the two report pages under Tutorial → "Coming from Classic Reports"; Everyday Work lists the guides without RAP first.

Fixed along the way

  • User Exits said a method is called "more than once" and "at most once" per request.
  • The table examples appended 100 rows again on every return to the app.
  • The glossary and cheat sheet use _bind( ) and follow_up_action( ), not the obsolete _bind_edit( ) / _event_client( ).

Worth a look in review

  • The CSP-header snippet and the production exit class are derived from the framework source and pass check:examples; they were not run on an SAP system.
  • Version minimums (monitor 1.147, cockpit 1.146, embed 1.145) are unchanged — the changelog does not confirm them either way.
  • check:samples could not run locally (no samples checkout); CI runs it.
  • Still to re-shoot on a real system: the abapGit screenshots and the two SICF dialogs.

Checks

npm run check passes locally: 180 tests and every gate except the skipped check:samples.


Generated by Claude Code

…teps, first-use definitions

- new Glossary page under Getting Started: one word per concept, and the app draft told apart from the RAP draft
- Quickstart: the SICF step as numbered clicks, and a verification with the expected result of each step
- Hello World, tutorial steps 2 and 3, In a Nutshell: check_on_navigated, n/v/ns, roundtrip and draft explained where they first appear
- RAP draft handling page warns about the two meanings of draft
- Security: how to send the CSP as a response header, which the go-live table asks for
- User Exits: the two statements on how often a method is called no longer contradict each other
- Tables: the examples fill the table once, not on every return

Co-Authored-By: Claude Fable 5.2 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_014YZFmDmG7XKbYzRh15T5C5
…hots, a report of long sentences

- every tutorial step says what the reader should see; steps 6, 8 and 10 name what is new
- In a Nutshell, Hello World and the Quickstart each lead to one next step
- Everyday Work lists the guides without RAP first and says how to get each sample
- Developer Tools and startup page screenshots are current, in English and hosted here
- the diagrams follow the insights originals again
- npm run report:sentences lists sentences over 35 words; it is a report, not a check

Co-Authored-By: Claude Fable 5.2 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_014YZFmDmG7XKbYzRh15T5C5
…a paragraph carried the design

- Productive Usage is now the Go-Live Checklist and opens the Configuration chapter: what, where, how to verify, and a production exit class to copy
- new page AI Setup: The Recommended Path, three steps with one command each; the other AI pages link to it
- Deployment Scenarios is a decision table with the one frontend-branch table
- Authorization and User Exits state their rules as tables; Monitoring puts the operator part first
- check, interface and plain words for gate, seam, pin and fails open

Co-Authored-By: Claude Fable 5.2 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_014YZFmDmG7XKbYzRh15T5C5
- the cookbook index and the cheat sheet open with an I want to table that links the call or the section
- Popup, Tables, Backend events, Frontend actions, Messages and Navigation lead with the shortest working example
- every example dispatches through one init / navigated / event chain
- app draft, sub-app, frontend action and event binding are used throughout; RAP drafts keep their name
- the glossary no longer names two obsolete calls

Co-Authored-By: Claude Fable 5.2 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_014YZFmDmG7XKbYzRh15T5C5
…P developer looks

Co-Authored-By: Claude Fable 5.2 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_014YZFmDmG7XKbYzRh15T5C5
…ms, the two longest pages split

- sentences over 35 words go from 8.1% to 1.3% of the manual: split, positive first, lists for enumerations
- ten cookbook pages are named after the task (Building a View, Handling Events in ABAP, More than 100 Rows, ...); addresses are unchanged
- Lock and RAP Draft Handling keep the overview and the short snippets; the full sources move to pages of their own
- new diagrams: table binding, URL modes, frontend actions, the request path and who checks what, the lost update, RAP draft states, the AI tool map
- what you should see after a step in the launchpad, Public Cloud, logout and setup pages; more glossary terms
- Hello World and the tutorial index point classic report developers to the report pages

Co-Authored-By: Claude Fable 5.2 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_014YZFmDmG7XKbYzRh15T5C5
@oblomov-dev
oblomov-dev merged commit 9efac90 into main Nov 12, 2026
1 check passed
@oblomov-dev
oblomov-dev deleted the claude/fervent-hawking-bo7lxc branch November 12, 2026 11:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants