What's in These Docs?
This is missing a lot of information. It needs to include the app section as the next place they should go, and then the individual user guides from there. The technical documentation should be included but really muted.
What's in These Docs?
This is missing a lot of information. It needs to include the app section as the next place they should go, and then the individual user guides from there. The technical documentation should be included but really muted.
Cost — Over 100% cheaper than most ERPs, 25% cheaper than the nearest competitor
Drop this because someone can then easily say, "Oh crap, they used the cheap crappy solution."
We couldn't see our financials clearly. No gross profit by customer, project, or business unit. Leadership was making decisions without the numbers to back them up.
Since this is mostly for a non-financial field service audience, use the principles of behavioral economics to cater towards them, like putting financials last and really dialing in on the fact that we live out of Google Chat and email; that's where all our cues are. Maybe make this a separate bullet point and delete or combine other bullet points to make this point.
ERP system
No one knows what an ERP is. If you're going to use it here, include a little footnote below this section that says what it is and then says humorously that we'll never use this term again. Also do the same on the Hussam page. Have a little asterisk next to ERP that defines it below.
If you can't find a field you're expecting, check the notebook tabs. It's usually in one of them.
drop this pointless line.
FollowersFollowers get notified when a message is posted to the record. When you're assigned to a task you're added automatically. To add or remove someone, click the people icon at the top of the chatter.
stick this after the screenshot for better flow
In the top-right of every record
Not every record. Just some records.
Smart buttons are the fastest way to pivot between related things
More precise: "to switch between things related to a given record view."
Faster than navigating through menus.
drop this
Get in the habit of clicking the breadcrumbs rather than the browser's back button. It's more reliable: the back button can drop unsaved edits or land you on a stale view.
stick this in a alert after the screenshot for better flow
, or from one record into a related one,
stick this in parenthesis or emdashes for better flow
Use the statusbar when you're inside a single record. Use the kanban when you're managing many records across stages at once.
they don't need to be told this
Same data, two ways to work with it.
I had this kind of fake sophistication and humanity. Never do it.
Across the top, header fields hold the most important information (name, customer, dates, assignee).Below the header sit tabs that group related fields.To the side (or bottom) is the chatter.In the top-right corner sit count tiles called smart buttons.
I think you halucinated all of this. make sure it actually matches what we've documented in the following sections.
(Note: not every table supports every view. For example, there's no calendar view for inventory items.)
Stick this under the screenshot in italics so it's clearly reduced in priority. Or do a light gray if that's native to VitePress.
The same table can be displayed as a list, kanban board, Gantt chart, calendar, pivot table, or graph. Same data, different shape. Pick the shape that matches what you're trying to see.
Very fluffy. Just needs a one sentence lead in.
Once you know them, the rest is mostly vocabulary.
I don't even know what this means. Drop or clarify
Read top to bottom if you're new. Skim the headings if you've been in the system a while and come back when something looks unfamiliar.
Just drop this.
← Back to User Guides
Flesh this out a bit. Maybe a section that says "Where to go next" and then has links to each of the user guides for each of the personas. This reads like a breadcrumb. It sure would be more of a "Related article/what to read next" section.
Global search is the fastest way to get anywhere in Wyatt. Press ⌘K (Mac) or Ctrl-K (Windows) anywhere in the system and a command palette opens. Type a customer name, a task reference, or a product SKU, and jump directly to the record.
Three separate ideas should be on three separate lines.
If you open a record and can't find a field you're expecting, check the notebook tabs. It's usually in one of them.
This entire notebook section just feels super verbose. Knock it off.
Notebooks keep forms from becoming overwhelming. The fields you need most are in the header. The rest are tucked into tabs.
This reads like cheap ad copy. Probably just drop it.
At the bottom of most record forms is a notebook: a section with multiple tabs that group related fields. Tabs on a task might be Description, Time Entries, Service Requests, Sub-tasks. Only one tab is visible at a time. Click to switch.
Way, way, way too much information in one paragraph.
Followers are the people who get notified when a message is posted to the record. When you're assigned to a task you're added automatically. To add or remove someone, click the people icon at the top of the chatter.
This is good information to put in a call out.
Chatter is permanent, searchable, and visible to anyone who can open the record. Don't use it for conversations that shouldn't live on the record forever.
Drop this. We don't want them withholding information because they're worried about it being permanent.
Three things live in chatter:
Make this an ordered list rather than an unordered list. It will pull the eye through better.
It's the single source of truth for what happened with this record.
Too bold a statement. It's not the single source of truth. It's just where records, notes, changes, and discussions related to the thing go.
Smart buttons are the fastest way to pivot between related things.
This is a nice, clear, human, and non-pretentious line. It should be the first line of the smart button section, and you should find a way to write like this more often.
Prefer breadcrumbs over the browser's back button. The back button can drop unsaved edits or land you on a stale view.
"Prefer" is too coy. Just say " When you want to get into a previous page, get in the habit of clicking the breadcrumbs rather than the browser's back button. It's more reliable, blah blah blah.'
Some stages require certain fields to be filled before a record can move into them: a resolution code before Closed, a customer before Confirmed. If Wyatt won't advance the stage, scroll up to find a red outline on the missing field. If a kanban drag doesn't stick, the target stage likely has a required field or you don't have permission to make that transition.
drop this ... it's not true yet
How to advance a record: on many workflows (tasks, CRM opportunities, service requests) you can click a future stage on the statusbar or drag a kanban card into a new column, and the record jumps. On others (sales orders, invoices, purchase orders) the workflow is gated by action buttons in the record header like Confirm or Validate, not by clicking the statusbar.
break this into one line per idea to make it scannable.
You see the same statuses in two places:
This is well done but put the images below each of the two bullet points ... instead of blob of text followed by images put the image below each line of text it illustrates.
On the record form
We call it the record view not the record form. Also update six above to say record view not just record.
Most records move through a sequence of stages called statuses. A task goes from Open to In Progress to Completed to Closed. A sales order goes from Quotation to Confirmed to Done.
Make clear when you are giving examples and break out idea per line.
Better would:
Most records move through a sequence of stages called statuses. (For example: A task goes from Open to In Progress to Completed to Closed.)
Most of your day in Wyatt is spent inside records.
Very nice.
A record is a single item from a table: one task, one customer, one invoice.
Make clear when you are giving examples. That makes it scan better;
For here I would do: "A record is a single item from a larger table. (Example: a task, customer, or invoice.)"
The icons to switch views sit in the top-right of every table. Not every table supports every view: dispatchers use Gantt on tasks, accounting uses Pivot on journal entries, sales uses Kanban on opportunities.
This is good information but does not scan well. I would say:
To switch views, click the icons on the top-right of every table.
(Note that not every table supports every view. Example: there's no calendar view for inventory items.)
Tables can hold thousands of items. Filters are how we narrow them down.
nice! Clear and does not use jargon
You won't see the word "table" in the UI. You'll see screen names like All Tasks, Contacts, Products. Each is a table of something.(A few screens don't fit this pattern: dashboards, report viewers, and pop-up wizards. They're exceptions, not the rule.)
too many words. I would just say hey, there are two ways of viewing records: 1. Individual records; we'll talk about that later. 2. The others are tables. Here's an example. show screenshot.
That's all you need to say.
A list of customers is a table. A list of tasks is a table. The customer you click into is one row from that table.
Verbose and talks down.
Most screens in Wyatt show you either a table (many items) or a single item from a table.
Nice to add to this "(see "Record View" below)"
top-level entries
tech speak! just need to say that the menu bar is unique to each app.
click the Wyatt logo
they actually don't click the logo. There is no Wyatt logo. They just click the chevron in the upper lefthand corner.
You spend most of your time inside one app at a time.
This is a totally vacuous sentence.
Each app is a full workspace with its own menus and its own data.
"Is a full workspace" add nothing and is just technical jargon. Better: "Each app has it's own menus, buttons, and way of presenting data own data."
Wyatt is a collection of apps
Better: "At its core, Wyatt is a collection of apps, all tightly integrated with each other:"
Learn these and every screen in the system uses the same pieces.
This sentence reads like two unconnected pieces of information but the second half is helpful. "Use the same pieces" is the way humans talk. The idea here is "these are the same 12 building blocks you'll see everywhere."
Wyatt runs on about a dozen patterns.
No one knows what a "pattern" is.