Comment by al_borland

Comment by al_borland 13 hours ago

0 replies

Document it well. My company released an internal library, and I wanted to be a good employee and use it, but it was too difficult. There would be a standard component that takes a standard parameter, but it didn’t work. The documentation didn’t say anything. There were 3 different versions of the library, and I couldn’t tell which was the correct one, and none of them were well documented. I was able to hunt down the code to see how the component was defined, and found out they went out of their way to change from the standard, which they probably thought made it easier, but without documentation it sucked.

After spending several days to do what I could do in about 2 minutes with a public library that conforms to some standards and is well documented, I gave up.