This is a mock-up of the in-progress Image BBS 3.0 Sysop Guide (using content from the Image BBS 1.2b Sysop Guide) to illustrate where sections could belong in the finished manual. A short idea of who wrote which sections or what information goes in new sections goes here too, for team feedback. |
It would be really nice to use conditional includes (which ASCIIdoctor can do!) of sysop-level commands/chapters and be able to output an Image BBS 3.0 User’s Guide with only user-level commands. |
I have decided to remove gerunds (nouns/verbs ending in ‘-ing’) from most headings whenever it makes sense ( e.g. change Reading → Read, Viewing → View, Editing → Edit). It’s easier to read, and easier to find using search functions. An argument for this: https://ffeathers.wordpress.com/2013/10/12/death-of-the-gerund-in-technical-documentation/ |
I vacillate between retaining the “headline text” style of Image BBS’s menu entries in headings, and converting to only initial caps—so for now there’s a mixture of both. Send help. https://businesswriting.com/guide-to-capitalizing-words-in-titles-and-headings/ |
Product Information
Support Channels
imagebbs.net
Online documentation hosted there, someday. Having https://www.github.io available for this preview helps immensely in the meantime.
Ryan is writing these.
License, No Warranty
MIT license? https://mit-license.org/ Only trouble is “for profit” phrasing.
Set Up Image BBS 3.0
Shared Image BBS 3.0 Setup Steps
Since a lot of steps are shared between different upgrade options, I chose to add this “Shared Image BBS 3.0 Setup Steps” section to cut down on a few pages of duplicate instructions. TODO: Verify the steps are in fact word-for-word duplicates.
Complete Module Type List
FIXME Some items here duplicate those of “Set Up Image BBS 3.0” section. Combine them somehow.
Get Things Going
Log On
What Now?
Learn about WF, RELedit, etc.
RELedit: Edit Sub-Boards/Libraries
Make these the first 2 chapters. Maintenance and configuration are really important sysop tasks. |
The commands listed in these headings are just temporary.
I’m checking them against s.menu * files to make sure I don’t forget something.
They will be transferred to both the TODO Command Reference Appendix and relevant chapters.
|
Main Prompt Maintenance Commands
VersatIle Commodore Emulator
Serial I/O Options
JiffyDOS ROMs
TODO Mention http://www.go4retro.com is a licensed distributor of physical JiffyDOS and emulator ROM images.