Discussion

Timo - Could I revise the manual?

1

nathanielbabiak 2022-05-11 03:07 (Edited)

Hi Timo,

I've done technical writing/editing professionally in the past, and I noticed a few things about the manual that made learning the console a bit difficult for me. Reviewing the forums and uploads, it appears many new users have the same set of initial questions, as they learn too. The info to answer their questions is in the manual (or can be tested in-code), it's just a bit difficult to interpret.

Would you be interested in any revisions to the manual? I'd keep your "writer's voice" (not intending to change that). There's three specific areas I'd be interested in revising.

First, the graphics. I'd swap a few terms that are perhaps inconsistent. Every instance of following terms would be reviewed, and for approx. 25% of all instances, I'd recommend a replacement with a more applicable term from this same list:

Second, I've got this page of info that, essentially, does not appear in the manual. I don't think 100% of it should appear, but perhaps a fraction that's well above 0%?

Third, the manual contains at least one phrase that is suitable for a very old version of the console, perhaps even before v1.0, and I'd review for any additional revisions from this perspective.

Please don't take these three things as criticism - the manual is impressive! The tone is conversational and fun, and nearly all topics are coherent and organized. It's also obvious that it had an author/editor with a reasonable background in technical writing. But, new users might stick around longer if the initial difficulty were lowered a bit. (And I hate so much that this console isn't more popular!)

Please let me know, happy to help! :-)

~Nate


nathanielbabiak 2022-05-11 04:10 (Edited)

As a sample (unrelated to what's above), here's how I'd make the layers a bit clearer. This revision no longer shows that sprites can appear in front of one another in a way that respects the priority attribute. (If I did the whole manual we could pick a workflow that makes more sense than forum posts...)

GRAPHICS

...

The display is composed of 3 layers, which are from back to front:

Each sprite and background cell has an attribute called "priority". By setting it, the cell or sprite will appear in front of the other 2 layers. on a higher display layer. Actually there are 6 layers, from back to front:


Timo 2022-05-12 13:54

Hi. I wouldn’t mind if you did it, for sure it can be improved. But there is already one issue for me: To make it the new official manual, I would have to release an update for all platforms, and this is quite annoying.

I doubt it’s worth the effort. I think the manual is understandable for technical people. People without experience will probably not even read the manual. They are usually much more interested in tutorials, which really lack for LowRes NX.

I could imagine that tutorials for different game genres would be helpful. Maybe even simple example games with tutorials on how to change them (add own maps/graphics etc.)…


nathanielbabiak 2022-05-13 04:53

Understood, I didn't know the that.

On the topic of tutorials (I think I mentioned this once before?), I'd be happy to create these. Is there a tutorial for another language you like? Maybe a prototypical/example (go-by) web address you could provide?

I'd like to start from an existing tutorial since it'll provide the "writer's voice" and I'd only need to get it formatted for Markdown and ported to LowRes NX, you know?


Timo 2022-05-13 19:35

I don't know any specific tutorials, but I could imagine that there are some Pico-8 tutorials which could be ported to LowRes NX...


nathanielbabiak 2022-05-13 22:11

Good deal. I'll dig around for some. (Didn't want to be the first one to mention your competition!)


was8bit 2022-05-14 15:12

... for me, there is no competition.... NX, its creator, and the community here, by far outshines all others! :D


GAMELEGEND 2022-05-14 21:32

@was8bit NX is the best

ever since i found NX i have not used any other fantasy console


was8bit 2022-05-15 04:17

:D


Log in to reply.