Technical writer or analyst?

Question

Documentation

HelloThe process of developing a new project is underway

and I see that we are stalling in the field of writing regulations, instructions and descriptions of processes and the product itself

.
`y (Working with tickets, commits, branches, issuing release notes, etc.) - but no one can describe this process in an understandable language in the form of an instruction-regulation, well, or it seems that they described it well - but it will not be clear to a new person.
2) It seems to be for all the functionality that we do and put Tickets, and describe product requirements, test cases, user guide - but again, it feels like there is no single documentation structure.
There are people from whom you can take information about how it works, and what, and

why there is an entry of a new person - this is an immersion for many months in the proceedings, but how do we all work)

We work on Atlassian products (Jira, Confluence, BitBucket, Fish Enu + Crucible, Bamboo).

Question - Who should / can solve this " pain" is more of a task for a technical writer or a business analyst?

Thanks

Answer 1


We agreed on a certain process, for example, we need to work on Development (Working with tickets, commits, branches, issuing release notes, etc.)
...
It seems to be for all the functionality that we do and put Tickets, and describe product requirements, test cases, user guide - but again, it feels like there is no single documentation structure.
...
Question - Who should / can solve this "pain"

The task of the correct organization of the development process should be solved by the technical project manager.
Having clear formalized documentation is definitely a plus, but in my personal experience, entering a new person into a complex monolithic project still takes time, because documentation tends to grow uncontrollably.
The solution is largely architectural, to split the project into simple microservices, each of which has independent documentation, etc.

Answer 2

In my opinion, the problem is not in the technical writer or analyst, but in insufficiently effective project management.
A professional manager is the very “link” that will not only hold a competent meeting with a real result and systematically organize work with documentation, but will also be able to set up basic management processes, such as: planning, coordination, control, etc. It's just a matter of finding a good manager. Other solutions, including technical or software and service solutions, will not only not solve these problems, but will also aggravate the situation. Probably the project has reached the point of development when it is necessary to establish management.

Answer 3

A technical writer may not understand the subject area deeply enough, and an analyst may not be able to write in human language.
Therefore, you need both. But, since there are people in the team who understand how and what works, you can try to do without an analyst.

Answer 4

1. Management should solve all headaches.
Or more precisely - a person interested in the project with sufficient authority should give everyone a kick as soon as something starts to slip.
If there is no such person (he does not have enough authority or interest) - close the project.
2. It is enough to make a boilerplate (a template or several) - which everyone will use. By order.
No one will read all these long regulations, etc.
Descriptions of how to work - should be 3-4 screens high, no more.
Don't let people work.
Help them - make your corporate boilerplate
Man just take it.
And modernizes it for its project site.
Заведите удобный wiki-подобный комментарий к boilerplate.
Документация появится сама.