Tech Writing - Opinion needed per consistency of field tables


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?

Stephen KairysTechnical Writer - ConsultantAsked:
Who is Participating?
CompProbSolvConnect With a Mentor Commented:
I'd leave them out if a reasonable reader wouldn't question why they aren't there.  I'd also consider a footnote that Remarks aren't included as they are unnecessary.
Ryan ChongCommented:
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.
Stephen KairysTechnical Writer - ConsultantAuthor Commented:
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.
Question has a verified solution.

Are you are experiencing a similar issue? Get a personalized answer when you ask a related question.

Have a better answer? Share it in a comment.

All Courses

From novice to tech pro — start learning today.