News for hackers. Stuff that matters.
Re:Ask HN: How does your team handle knowledge documentation? by pedrorijo91 on Monday November 06, 2017 @01:23PM (#15637529)
Don't use confluence :( In every team I've been, confluence feels like an huge hole, we can never find what we are looking for...
Re:Ask HN: How does your team handle knowledge documentation? by sz4kerto on Monday November 06, 2017 @01:26PM (#15637567)
That's probably because you've used Confluence. If you used something else, then that'd have been the huge hole.

Confluence is a very good wiki. There's no wiki that creates good structures for you automagically.

Re:Ask HN: How does your team handle knowledge documentation? by nwatson on Monday November 06, 2017 @02:16PM (#15638094)
Confluence is still the best Wiki out there for general documentation itself, in my opinion. It takes work though to create the initial structure with a realistic view of how projects will evolve, and to make sure that everything is reachable through an organized hierarchy (or lattice, or DAG) reachable from the Space root. What sucks is random "floating" pages not tied to anything else -- these get lost.

There are various orthogonal concerns to deal with when documenting software development with Confluence:

+ knowing the underlying platforms / technologies your project uses

+ architecture / design of system (which will evolve over releases) -- Gliffy plugin works well for illustrations

+ documenting releases

+ engineering-level precursors to user documentation

+ meetings -- high-level overview of discussions, decisions, resulting actions

+ Confluence wiki integration with bug-tracker, source code repositories

Without an up-front design one will run into problems. Even worse if managing several projects.

Re:Ask HN: How does your team handle knowledge documentation? by dalemyers on Monday November 06, 2017 @01:27PM (#15637579)
We actually used Confluence but moved away from it. The interface was difficult to use, it was slow, the search wasn't great, etc.
Re:Ask HN: How does your team handle knowledge documentation? by pedrorijo91 on Monday November 06, 2017 @01:35PM (#15637651)
yeah, same pains that I've felt. I get the feeling that Atlassian products always lack some UI love
Re:Ask HN: How does your team handle knowledge documentation? by ravitation on Monday November 06, 2017 @02:01PM (#15637930)
Away from Confluence and to the documentation directories?
Re:Ask HN: How does your team handle knowledge documentation? by waibelp on Tuesday November 07, 2017 @12:01PM (#15645101)
This! As we use JIRA for ticketing we thought Confluence would be the best way. But like you said the problem is not that the information is not there. The problem is that the information is not findable and the search is in my opinion really poor.

To solve that problem we started with a "doc" directory in each repository holding multiple markdown files for each topic. That way all of our developers are able to find the information they need (even without an internet connection).

Re:Ask HN: How does your team handle knowledge documentation? by maxxxxx on Monday November 06, 2017 @02:14PM (#15638088)
Definitely don't use SharePoint either! It's the ultimate data black hole.