Link to home
Start Free TrialLog in
Avatar of Stephen Kairys
Stephen KairysFlag for United States of America

asked on

Tech Writing - Opinion needed per consistency of field tables

Hi,

I'm documenting a set of (e.g.) ten screens. Nothing fancy, just a bunch of screenshots. Plus, tables containing:
  • Field Name
  • Datatype.

For three of the tables, I need to provide additional info, so I added a Remarks column. But, it's not needed for the remaining seven tables.

Is it considered better form to include the Remarks column anyhow, for consistency's sake? Or, does a column with no info look bad?

Thanks.
ASKER CERTIFIED SOLUTION
Avatar of CompProbSolv
CompProbSolv
Flag of United States of America image

Link to home
membership
This solution is only available to members.
To access this solution, you must be a member of Experts Exchange.
Start Free Trial
it's based on user requirements whether to include a field or not, including this remark field.

so, if user requested to have ability to note something as a remark, then we got to design an interface to input it. even though it could be empty. while if that field is not necessary at all, then we no need to have a field there in the design.
Avatar of Stephen Kairys

ASKER

Thanks, CompProbSolv.

Ryan: I appreciate your input. But, the question is not about designing an application that includes a table with a REMARK column. Rather, it's pertains to documentation for a form with multiple fields that can vary.