TechWhirl (TECHWR-L) is a resource for technical writing and technical communications professionals of all experience levels and in all industries to share their experiences and acquire information.
For two decades, technical communicators have turned to TechWhirl to ask and answer questions about the always-changing world of technical communications, such as tools, skills, career paths, methodologies, and emerging industries. The TechWhirl Archives and magazine, created for, by and about technical writers, offer a wealth of knowledge to everyone with an interest in any aspect of technical communications.
Subject:Standards: Few & long vs. many & short From:Jessica Behles <j -dot- e -dot- behles -at- gmail -dot- com> To:techwr-l -at- lists -dot- techwr-l -dot- com Date:Tue, 4 May 2021 11:06:25 -0600
Hi folks,
I manage cybersecurity standards. Currently, our docs are extremely long
and cover (in my opinion) way too many topics. I constantly have people
(regulators, users, etc.) coming to me to ask in which standard they can
find x topic covered. I want to propose to my management breaking up the
standards into smaller documents based on topic (e.g. instead of broadly
having a single communications standard, have firewalls, networking, remote
access, and wifi standards). I feel that doing so will make them more user
friendly and I won't ever again have to answer, "Where are the firewall
standards?"
However, I'm not sure if my management will accept my gut feeling
(especially because prior to my involvement, we had the standards broken up
in such a way, but somebody decided we had too many standards, resulting in
the hot mess we have today). So I was wondering if anyone had any data
around few/long vs. many/short and which approach is better--articles, case
studies, etc. I've looked, but haven't had much luck thus far.
Alternately, if anyone has any strong feelings either way, I'd like to hear
them--maybe my gut feeling is completely off base and I simply don't
realize it
Thanks!
-Jessica
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Visit TechWhirl for the latest on content technology, content strategy and content development | https://techwhirl.com