4
theuser
5y

Been working frontend on a very large ASP.Net Core project with React. The company is a multi national oil company. I asked for some documentation on their React components, like where is the props, why is this component showing this side-effect and is there a component for X and Y so that you won't have to pay me in order to dig around in the codebase? They told me they will document the frontend when the project is finished (whenever that may be?)

So basically, there won't ever be any documentation then.

Comments
  • 0
    Where do you find .net core jobs?
  • 0
    Documentation on frontend projects? Never seen that. Theres implicit documentation like tests, proptypes or the usage of typescript. Sometimes a bit more in the form of a kitchensink or storybook for some basic components.

    Ive seen api docs or docs for clients how to configure stuff in the backoffice or even technical/architectual docs how in a greater scheme stuff works.

    In my experience, whatever documentation a frontender would write, would either be to simple, out of date, or to much yargon. Try describing a form, hiw it works in a general sense (redux/state management) and then in detail about the validations, and then even deeper how the datepicker works and which props are needed. That alone would be weeks of documenting, so 1 newcomer can save a day digging through code
  • 0
    So they plan to write the docs when the project is dead?
Add Comment