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.
LVL 4
Stephen KairysTechnical Writer - ConsultantAsked:
Who is Participating?

[Product update] Infrastructure Analysis Tool is now available with Business Accounts.Learn More

x
I wear a lot of hats...

"The solutions and answers provided on Experts Exchange have been extremely helpful to me over the last few years. I wear a lot of hats - Developer, Database Administrator, Help Desk, etc., so I know a lot of things but not a lot about one thing. Experts Exchange gives me answers from people who do know a lot about one thing, in a easy to use platform." -Todd S.

CompProbSolvCommented:
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.
1

Experts Exchange Solution brought to you by

Your issues matter to us.

Facing a tech roadblock? Get the help and guidance you need from experienced professionals who care. Ask your question anytime, anywhere, with no hassle.

Start your 7-day free trial
Ryan ChongBusiness Systems Analyst , ex-Senior Application EngineerCommented:
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.
0
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.
0
It's more than this solution.Get answers and train to solve all your tech problems - anytime, anywhere.Try it for free Edge Out The Competitionfor your dream job with proven skills and certifications.Get started today Stand Outas the employee with proven skills.Start learning today for free Move Your Career Forwardwith certification training in the latest technologies.Start your trial today
Web Applications

From novice to tech pro — start learning today.