> What if they start reading it but just glaze over because of the sheer volume of it?
Write concisely and in order of importance. The Inverted Pyramid model [1] is helpful. Key points answering questions Why, What, When, How, Where go up front. Then, important details. Finally, internal musings and background info go to the bottom. This way, the reader can stop at any time and they won't miss anything crucial.
Another important tip is to refine the documents you've already written. Think of it as refactoring. Rewerite unclear, long sentences. Be consistent in describing the same procedures. Delete parts that aren't necessary anymore.
Just like maintating the old code, it takes time and may seem as a waste of efforts. But it's well worth it.
> I've got nobody to check my work either.
Are there any other stakeholders that may be interested in what you're doing? Interns? Vendors? Ideally, your documents should be written so anyone can understand the main points and follow them. They don't have to gork the gory details and that's fine. Ask your collegues anyway, even if it's a first few paragraphs.
Write concisely and in order of importance. The Inverted Pyramid model [1] is helpful. Key points answering questions Why, What, When, How, Where go up front. Then, important details. Finally, internal musings and background info go to the bottom. This way, the reader can stop at any time and they won't miss anything crucial.
Another important tip is to refine the documents you've already written. Think of it as refactoring. Rewerite unclear, long sentences. Be consistent in describing the same procedures. Delete parts that aren't necessary anymore.
Just like maintating the old code, it takes time and may seem as a waste of efforts. But it's well worth it.
> I've got nobody to check my work either.
Are there any other stakeholders that may be interested in what you're doing? Interns? Vendors? Ideally, your documents should be written so anyone can understand the main points and follow them. They don't have to gork the gory details and that's fine. Ask your collegues anyway, even if it's a first few paragraphs.
[1] - https://en.wikipedia.org/wiki/Inverted_pyramid_(journalism)